diff --git a/docs/models/dcim/devicerolegroup.md b/docs/models/dcim/devicerolegroup.md new file mode 100644 index 000000000..f423ecd50 --- /dev/null +++ b/docs/models/dcim/devicerolegroup.md @@ -0,0 +1,19 @@ +# Device Role Groups + +[Device Roles](./devicerole.md) can be organized by custom groups. For instance, you might create one group called "Rack Infrastructure" and one called "Network Switches." The assignment of a device role to a group is optional. + +Device role groups may be nested recursively to achieve a multi-level hierarchy. For example, you might have a group called "Rack Infrastructure" containing subgroups of individual device roles grouped by types. + +## Fields + +### Parent + +The parent device role group (if any). + +### Name + +A unique human-friendly name. + +### Slug + +A unique URL-friendly identifier. (This value can be used for filtering.) diff --git a/mkdocs.yml b/mkdocs.yml index f0bd9af7a..a17e02e14 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -185,6 +185,7 @@ nav: - DeviceBay: 'models/dcim/devicebay.md' - DeviceBayTemplate: 'models/dcim/devicebaytemplate.md' - DeviceRole: 'models/dcim/devicerole.md' + - DeviceRoleGroup: 'models/dcim/devicerolegroup.md' - DeviceType: 'models/dcim/devicetype.md' - FrontPort: 'models/dcim/frontport.md' - FrontPortTemplate: 'models/dcim/frontporttemplate.md'