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

Finish refreshing DCIM models documentation

Browse Source
This commit is contained in:
jeremystretch
2022-08-15 15:16:02 -04:00
parent f76ce172e0
commit 4307f078ed
28 changed files with 547 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/models/dcim/region.md
View File

@@ -1,5 +1,17 @@
# Regions
Sites can be arranged geographically using regions. A region might represent a continent, country, city, campus, or other area depending on your use case. Regions can be nested recursively to construct a hierarchy. For example, you might define several country regions, and within each of those several state or city regions to which sites are assigned.
[Sites](./site.md) can be arranged geographically using regions. A region might represent a continent, country, city, campus, or other area depending on your use case. Regions can be nested recursively to construct a hierarchy. For example, you might define several country regions, and within each of those several state or city regions to which sites are assigned.
Each region must have a name that is unique within its parent region, if any.
## Fields
### Parent
The parent region, if any.
### Name
The region's name. Must be unique to the parent region, if one is assigned.
### Slug
A unique URL-friendly identifier. (This value can be used for filtering.)