You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/api.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -168,7 +168,7 @@ The response will include the created object with its assigned ID and additional
168
168
169
169
### API output in the browser
170
170
171
-
As with other NetBox objects, you can also view the API output for given Custom Objects by prepending `api/` to the URL, e.g. `api/plugins/custom-objects/dhcp_scope/`
171
+
As with other NetBox objects, you can also view the API output for given Custom Objects by prepending `api/` to the URL, e.g. `api/plugins/custom-objects/dhcp_scopes/`
Copy file name to clipboardExpand all lines: docs/index.md
+12-8Lines changed: 12 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -48,14 +48,18 @@ Let's walk through the above DHCP Scope example, to highlight the steps involved
48
48
### Create the Custom Object Type
49
49
50
50
1. Navigate to the Custom Objects plugin in the left navigation pane and click the `+` next to `Custom Object Types`
51
-
2. Choose a name for your Custom Object Type. In this case we will choose `dhcp_scope`
51
+
2. Choose the relevant naming for your Custom Object Type.
52
52
53
-
> [!TIP]
54
-
> Give your Custom Object Types URL friendly names
53
+
| Field | Value |
54
+
|-------------------------|---------------|
55
+
| Internal name |`dhcp_scope`|
56
+
| Display name (singular) |`DHCP Scope`|
57
+
| Display name (plural) |`DHCP Scopes`|
58
+
| URL path/slug |`dhcp_scopes`|
55
59
56
60
> [!TIP]
57
-
> By default the plural name for your Custom Object Type will be its name with `s` appended. So for example, multiple `dhcp_scope` Custom Objects will be referred to as `dhcp_scopes`.
58
-
> This behaviour can be overridden using the `Readable plural name` field. For example if you have a Custom Object Type called `Child` you can use the `Readable plural name` field to specify `Children` instead of `Childs`
61
+
> You can optionally choose a version for for your custom object type, e.g. `0.1`
62
+
> Custom Object Type versioning will become more important in future releases of NetBox Custom Objects
59
63
60
64
3. Click `Create`
61
65
@@ -87,15 +91,15 @@ Typically, NetBox admins would be responsible for thinking through modelling req
87
91
88
92
Now that you've created your `DHCP Scope` Custom Object Type, let's go ahead and create a new `DHCP Scope`.
89
93
90
-
1. Under the NetBox Custom Objects plugin in the left side navigation you will now see `Dhcp_scopes`. Click on `+` next to your new Custom Object Type.
94
+
1. Under the NetBox Custom Objects plugin in the left side navigation you will now see `DHCP Scopes`. Click on `+` next to your new Custom Object Type.
91
95
2. As you added a single field, called `Range` of type `IPAM > IP Range` you are prompted to specify a range. Go and ahead and select one, then click `Create`.
92
96
3. You're now taken to the detail view for your new `DHCP Scope` object.
93
97
94
98
#### Standard list views for Custom Objects
95
99
96
-
As with core NetBox objects, Custom Objects have their own list views. To see all your `DHCP Scopes` you can just click on your Custom Object Type in the Custom Object plugin section in the left side navigation. In the example above, click on `Custom Objects` -> `OBJECTS` -> `Dhcp_scopes`
100
+
As with core NetBox objects, Custom Objects have their own list views. To see all your `DHCP Scopes` you can just click on your Custom Object Type in the Custom Object plugin section in the left side navigation. In the example above, click on `Custom Objects` -> `OBJECTS` -> `DHCP Scopes`
97
101
98
-
You will now see a standard NetBox list view for your new Custom Objects with the standard options including `Configure Table`, `+ Add`, Import, Export, etc
102
+
You will now see a standard NetBox list view for your new Custom Objects with the standard options including `Configure Table`, `+ Add`, `Import`, `Export`, etc
0 commit comments