mirror/netbox-community-netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2024-05-10 07:54:54 +00:00
Code Activity

Additional documentation cleanup

Browse Source
This commit is contained in:
Jeremy Stretch
2018-07-27 13:42:18 -04:00
parent 9eb433a4ef
commit 674a0d481e
10 changed files with 30 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/core-functionality/ipam.md
View File

@@ -58,7 +58,7 @@ Also like prefixes, each IP address can be assigned a status and a role. Statuse
* Deprecated
* DHCP
IP address roles are also hard-coded, and can be used to indicate a special condition of the IP address. Role assignment is optional. Available roles include:
Each IP address can optionally be assigned a special role. Roles are used to indicate some special attribute of an IP address: for example, it is used as a loopback, or is a virtual IP maintained using VRRP. (Note that this differs in purpose from a _functional_ role, and thus cannot be customized.) Available roles include:
* Loopback
* Secondary

2
docs/core-functionality/services.md
View File

@@ -1,5 +1,5 @@
# Services
A service represents a layer four TCP or UDP service available on a device or virtual machine. Each service includes a name, protocol, and port number; for example, "SSH (TCP/22)" or "DNS (UDP/53)."
A service represents a layer four TCP or UDP service available on a device or virtual machine. For example, you might want to document that an HTTP service is running on a device. Each service includes a name, protocol, and port number; for example, "SSH (TCP/22)" or "DNS (UDP/53)."
A service may optionally be bound to one or more specific IP addresses belonging to its parent device or VM. (If no IP addresses are bound, the service is assumed to be reachable via any assigned IP address.)

2
docs/core-functionality/tenancy.md
View File

@@ -13,7 +13,7 @@ A tenant represents a discrete entity for administrative purposes. Typically, te
* Circuits
* Virtual machines
If a prefix or IP address is not assigned to a tenant, it will appear to inherit the tenant to which its parent VRF is assigned, if any.
Tenant assignment is used to signify ownership of an object in NetBox. As such, each object may only be owned by a single tenant. For example, if you have a firewall dedicated to a particular customer, you would assign it to the tenant which represents that customer. However, if the firewall serves multiple customers, it doesn't *belong* to any particular customer, so tenant assignment would not be appropriate.
### Tenant Groups