Refreshed tenancy model documentation

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

View File

@@ -1,31 +1,33 @@
# Contacts
A contact represent an individual or group that has been associated with an object in NetBox for administrative reasons. For example, you might assign one or more operational contacts to each site. Contacts can be arranged within nested contact groups.
A contact represents an individual or group that has been associated with an object in NetBox for administrative reasons. For example, you might assign one or more operational contacts to each site.
Each contact must include a name, which is unique to its parent group (if any). The following optional descriptors are also available:
## Fields
* Title
* Phone
* Email
* Address
### Group
## Contact Assignment
The [contact group](./contactgroup.md) to which this contact is assigned (if any).
Each contact can be assigned to one or more objects, allowing for the efficient reuse of contact information. When assigning a contact to an object, the user may optionally specify a role and/or priority (primary, secondary, tertiary, or inactive) to better convey the nature of the contact's relationship to the assigned object.
### Name
The following models support the assignment of contacts:
The name of the contact. This may be an individual or a team/department. (This is the only required contact detail; all others are optional.)
* circuits.Circuit
* circuits.Provider
* dcim.Device
* dcim.Location
* dcim.Manufacturer
* dcim.PowerPanel
* dcim.Rack
* dcim.Region
* dcim.Site
* dcim.SiteGroup
* tenancy.Tenant
* virtualization.Cluster
* virtualization.ClusterGroup
* virtualization.VirtualMachine
### Title
The contact's title or role.
### Phone
The contact's phone number. (Note that NetBox does _not_ enforce a particular numbering format.)
### Email
The contact's email address.
### Address
The contact's physical or mailing address.
### Link
A URL to reach the contact via some other means.