Differences

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

--- 2_x:datamodel:ip-addresses [2019/02/26 11:50] – [Allocate Address to CI] cnaud
+++ 2_x:datamodel:ip-addresses [2019/12/05 16:19] – [Creating a new IP Address] cnaud
@@ Line 1: / Line 1: @@
+====== IP Addresses ======
+{{classicon_ipv4address.png  }}
+{{classicon_ipv6address.png  }}
+Obviously, IP Address objects in TeemIp modelize addresses of the Internet Protocol. Both version 4 and version 6 are supported.
+==== IP Address Properties ====
+^  Name  ^  Type  ^  Mandatory?  ^
+| **General Information** |||
+| Organization | Foreign key to a(n) Organization | Yes |
+| Status | Possible values: allocated, released, reserved, unassigned | Yes |
+| Usage | Foreign key to a(n) IP Address Usage | No |
+| Note | Multiline character string  | No |
+| Requestor | Foreign key to a(n) Person | No |
+| Allocation date | Date (year-month-day) | No |
+| Release date | Date (year-month-day) | No |
+| **DNS Information** |||
+| Short Name | Alphanumeric string | No |
+| Domain Name | Foreign key to a(n) Domain | No |
+| FQDN | Alphanumeric string | No |
+| Aliases | Array of alphanumeric strings | No |
+| **IP Information** |||
+| Subnet | Foreign key to a(n) Subnet | No |
+| Range | Foreign key to a(n) IP Range | No |
+| Address | Alphanumeric string  | Yes|
+<note tip>
+IP Address Usages are typology elements defined in the Data Administration module. One set of IP Adress Usage needs to be defined per organization.
+</note>
+<note important>
+The attribute "Status" is more than informative. It does have an impact on what can and cannot be done with an IP. Meanings of different values are:
+  * allocated: IP is in use and potentially allocated to a CI. It cannot be re-allocated to another CI without being released or unassigned first.
+  * released: IP is not in use anymore and can be re-allocated if required
+  * reserved: IP is not in use yet but will be allocated (activated) at a point in time. It can be allocated from the IP detail menu but is invisible from the CI edition menu.
+  * unassigned: IP exists in TeemIp without any clear status and can be allocated or reserved.
+</note>
+==== Tabs ====
+^  Tab  ^  Description  ^
+| Contacts | All the contacts for this IP |
+| Documents | All the documents linked to this IP |
+| NAT IPs | All other IPs linked to this IP in a NAT relationship |
+| CIs | All the configuration items configured with the IP |
+| History | History of all changes made to the IP |
+==== Listing IP Addresses ====
+The IP Addresses shortcuts of the IP Management module on the explorer menu display all the IPv4 or IPv6 Addresses of the selected organization or all IPv4 or IPv6 Addresses if no organization is selected.
+{{ classlist_ipv4address.png }}
+{{ classlist_ipv6address.png }}
+<note tip>
+The Search tab will shorten the list according to the filtering elements you'll define in it.
+</note>
+==== Creating a new IP Address ====
+From the listing view, click on the “New…” menu to display the creation form.
+{{ classcreate_ipv4address.png }}
+An implicit but intuitive set of rules are followed when an IP address is created:
+  * "Allocation date" and "FQDN" (Fully Qualified Defined Name) are automatically calculated when the address is created.
+  * If no Subnet is selected, the IP can be any IP of the IPv4 (or IPv6) space.
+  * If a Subnet and no Range are selected, the address must be included into the Subnet.
+  * If a Subnet and a Range are selected, the address must be included into the Range as well.
+  * An IP can be linked to any other registered IP address through the NAT tab.
+<note important>
+By definition, FQDNs are absolute domain names. They specify the exact location of domain names in the tree hierarchy of the Domain Name System (DNS). This is why they end up with a dot.
+</note>
+<note important>
+Though aliases are linked to FQDNs, they can be created through the IP address creation screen. The "Aliases" box allows IP administrators to create as many aliases they want. Syntax is to add one FQDN by line, separated by a carriage return.
+</note>
+At creation time, global settings “Allow Duplicate Names” and “Ping IP before assigning it ?” 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 tip>
+For v6 IPs, a simple autocompletion mechanism is used to help typing the IP: its first 64 bits are copied from the subnet IP… which can, of course, be manually changed by the user.
+</note>
+==== Modify an IP Address ====
+From the detailed view of an IP Address, click on the “Modify” button.
+Basically, all parameters can be changed here but, of course, the IP address itself.
+==== Other Actions ====
+Next to standard actions, a set of specific actions can be applied to IP Addresses. These can be found in the “Other Actions” menu available from the details page.
+{{details-popup-menu-ipaddressotheractions.png }}
+{{details-popup-menu-ipaddressotheractions2.png}}
+These specific actions are described in below chapters.
+==== Allocate Address to CI ====
+This action applies to IP Addresses that are released, reserved or unassigned. Its purpose is to allocate the address to a CI without having to open the modification form of the targeted CI.
+{{ classallocateip1_ipaddress.png }}
+Three parameters control the action:
+^  Name  ^  Type  ^  Mandatory?  ^
+| Target class | List the instantiated classes of objects that may be linked to an IP address | Yes |
+| Functional CI | List the CIs of class defined by Target class which an IP address can be allocated to | Yes |
+| IP Attribute | IP attribute of the CI that the IP should be allocate to | Yes |
+These parameters are automatically computed and may differ from one data model to another. For instance, a server may have only one IP address (it's management IP, like in the standard data model) or multiple ones (a management and a backup IP).  Once the CI is selected, TeemIp confirms the operation through the following screen.
+{{ classallocateip2_ipaddress.png }}
+<note>
+As soon as the action is done, the IP address status is changed to "allocated".
+</note>
+<note important>
+An IP can NOT be allocate to an IP interface that way.
+</note>
+==== Un-allocate address from all CI ====
+This action simply unallocate the IP from all CIs that it may be allocated to. This includes IP Interfaces. Action is launched as soon as the action is selected. A confirmation screen is then displayed.
+{{ classunallocateip_ipaddress.PNG }}
+<note>
+The IP address status is automatically changed to "unassigned".
+</note>
+==== Links between IP Addresses and CIs ====
+TeemIp has been designed to provide a comprehensive modelization and documentation of the link(s) that a CI and an IP address may share together.
+Some CIs, like servers or network devices, have one IP attribute that represents their management IP. For them:
+  * A unique IP can be attached to them,
+  * An IP address must be in the status Released or Unassigned to be attached to a CI,
+  * IPs that are in state Allocated cannot be set as IP Management attributes,
+  * Reserved IPs are... reserved,
+  * Once CI is created or updated, status of attached IP is automatically changed to Allocated,
+  * If an IP Management IP is removed from the CI, its status becomes Unassigned unless it is still linked to another CI.
+Some others CIs, like IP interfaces attached to routers, may host several IP addresses. For them:
+  * One or more IPs (with no limitation of quantity) can be attached to them,
+  * An IP can be attached to them, regardless their status,
+  * Once CI is created or updated, status of attached IP is automatically changed to Allocated,
+  * If a link with an IP address is removed, status of IP moves back to Unassigned unless it is still linked to another CI.
+=== Obsoleting CIs ===
+When a CI becomes obsolete, its IPs can automatically be released from it, as described in the [[2_x:datamodel:teemip_cmdb#obsoleting_cis|related CMDB chapter]].

Documentation

User Tools

Site Tools

Differences

Page Tools