From 8d8ac70070a83bc3129d6ff5f7d7a9fd76559cc8 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 16 Jul 2021 13:48:57 -0400 Subject: [PATCH] Add IP range documentation --- docs/core-functionality/ipam.md | 1 + docs/models/ipam/iprange.md | 11 +++++++++++ 2 files changed, 12 insertions(+) create mode 100644 docs/models/ipam/iprange.md diff --git a/docs/core-functionality/ipam.md b/docs/core-functionality/ipam.md index dd6eee77b..00267dfe0 100644 --- a/docs/core-functionality/ipam.md +++ b/docs/core-functionality/ipam.md @@ -10,6 +10,7 @@ --- +{!docs/models/ipam/iprange.md!} {!docs/models/ipam/ipaddress.md!} --- diff --git a/docs/models/ipam/iprange.md b/docs/models/ipam/iprange.md new file mode 100644 index 000000000..9d64ed964 --- /dev/null +++ b/docs/models/ipam/iprange.md @@ -0,0 +1,11 @@ +# 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. + +IP also ranges share the same [functional roles](role.md) 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: + +* Active - Provisioned and in use +* Reserved - Designated for future use +* Deprecated - No longer in use + +The status of a range does _not_ have any impact on its member IP addresses, which may have their statuses modified separately.