NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-12-18 11:22:25 -06:00
Code Issues Actions 10 Packages Projects Releases Wiki Activity

Refreshed tenancy model documentation

Browse Source
This commit is contained in:
jeremystretch
2022-08-12 16:19:34 -04:00
parent c697e2fbe1
commit 6db2ef2a83
7 changed files with 113 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/models/tenancy/tenant.md
View File

@@ -1,17 +1,17 @@
# Tenants
A tenant represents a discrete grouping of resources used for administrative purposes. Typically, tenants are used to represent individual customers or internal departments within an organization. The following objects can be assigned to tenants:
A tenant represents a discrete grouping of resources used for administrative purposes. Typically, tenants are used to represent individual customers or internal departments within an organization.
* Sites
* Racks
* Rack reservations
* Devices
* VRFs
* Prefixes
* IP addresses
* VLANs
* Circuits
* Clusters
* Virtual machines
## Fields
Tenant assignment is used to signify the 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.
### Name
A unique human-friendly name.
### Slug
A unique URL-friendly identifier. (This value can be used for filtering.)
### Group
The [tenant group](./tenantgroup.md) to which this tenant belongs (if any).