diff --git a/README.md b/README.md index c2cb60753..896769e81 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,10 @@ functionality is ready. # About this Library -This library is intended to be used for populating device types in [NetBox](https://github.com/netbox-community/netbox). -It contains a set of device type definitions expressed in YAML and arranged by manufacturer. Each file represents a -discrete physical device type (e.g. make and model). These definitions can be loaded into NetBox to obviate the need to -create device types and their associated components manually. +This library is intended to be used for populating device types in [NetBox](https://github.com/netbox-community/netbox) +version 2.7 or later. It contains a set of device type definitions expressed in YAML and arranged by manufacturer. Each +file represents a discrete physical device type (e.g. make and model). These definitions can be loaded into NetBox to +obviate the need to create device types and their associated components manually. If you would like to contribute to this library, please read through our [contributing guide](CONTRIBUTING.md) before submitting content. @@ -28,6 +28,9 @@ The following fields may optionally be declared: (Default: true) * `subdevice_role`: Indicates that this is a `parent` or `child` device. (Default: None) +For further detail on these attributes and those listed below, please reference the +[schema definition](tests/schema.json). + ## Component Definitions Valid component types are listed below. Each type of component must declare a list of the individual component templates @@ -47,44 +50,44 @@ The available fields for each type of component are listed below. ### Console Ports * `name`: Port name -* `type`: Port type +* `type`: Port type slug (API value) ### Console Server Ports * `name`: Port name -* `type`: Port type +* `type`: Port type slug (API value) ### Power Ports * `name`: Port name -* `type`: Port type +* `type`: Port type slug (API value) * `maximum_draw`: The port's maximum power draw, in watts (optional) * `allocated_draw`: The port's allocated power draw, in watts (optional) ### Power Outlets * `name`: Outlet name -* `type`: Port type +* `type`: Port type slug (API value) * `power_port`: The name of the power port on the device which powers this outlet (optional) -* `feed_leg`: The phase (leg) of power to which this outlet is mapped (optional) +* `feed_leg`: The phase (leg) of power to which this outlet is mapped; A, B, or C (optional) ### Interfaces * `name`: Interface name -* `type`: Inteface type +* `type`: Interface type slug (API value) * `mgmt_only`: A boolean which indicates whether this interface is used for management purposes only (default: false) ### Front Ports * `name`: Port name -* `type`: Port type +* `type`: Port type slug (API value) * `rear_port`: The name of the rear port on this device to which the front port maps * `rear_port_position`: The corresponding position on the mapped rear port (default: 1) ### Rear Ports * `name`: Port name -* `type`: Port type +* `type`: Port type slug (API value) * `positions`: The number of front ports that can map to this rear port (default: 1) ### Device Bays