estel/netbox
1
0
Fork 0
Code Issues Pull Requests Actions 4 Packages Projects Releases Wiki Activity

Update IPAM models documentation

Browse Source
This commit is contained in:
jeremystretch
2022-08-16 15:32:00 -04:00
parent 4307f078ed
commit d43c98d546
17 changed files with 331 additions and 89 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
docs/models/ipam/iprange.md
View File

@@ -1,14 +1,30 @@
# IP Ranges
This model represents an arbitrary range of individual IPv4 or IPv6 addresses, inclusive of its starting and ending addresses. For instance, the range 192.0.2.10 to 192.0.2.20 has eleven members. (The total member count is available as the `size` property on an IPRange instance.) Like prefixes and IP addresses, each IP range may optionally be assigned to a VRF and/or tenant.
This model represents an arbitrary range of individual IPv4 or IPv6 addresses, inclusive of its starting and ending addresses. For instance, the range 192.0.2.10 to 192.0.2.20 has eleven members. (The total member count is available as the `size` property on an IPRange instance.) Like [prefixes](./prefix.md) and [IP addresses](./ipaddress.md), each IP range may optionally be assigned to a [VRF](./vrf.md).
IP also ranges share the same functional roles as prefixes and VLANs, although the assignment of a role is optional. Each IP range must be assigned an operational status, which is one of the following:
## Fields
* Active - Provisioned and in use
* Reserved - Designated for future use
* Deprecated - No longer in use
### VRF
The status of a range does _not_ have any impact on its member IP addresses, which may have their statuses modified separately.
The [Virtual Routing and Forwarding](./vrf.md) instance in which this IP range exists.
!!! note
VRF assignment is optional. IP ranges with no VRF assigned are considered to exist in the "global" table.
### Start & End Address
The beginning and ending IP addresses (inclusive) which define the boundaries of the range. Both IP addresses must specify the correct mask.
!!! note
The maximum supported size of an IP range is 2^32 - 1.
### Role
The user-defined functional [role](./role.md) assigned to the IP range.
### Status
The IP range's operational status. Note that the status of a range does _not_ have any impact on its member IP addresses, which may have their statuses defined independently.
!!! tip
Additional statuses may be defined by setting `IPRange.status` under the [`FIELD_CHOICES`](../../configuration/data-validation.md#field_choices) configuration parameter.