NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-07-23 04:22:01 -06:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity

Docs updates

Browse Source
This commit is contained in:
Jeremy Stretch 2019-08-15 16:07:15 -04:00
parent cb0dbc0769
commit 305d330391
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/additional-features/custom-scripts.md
View File

@ -63,6 +63,15 @@ The order in which the variable fields should appear. This is optional, however
fields = ['var1', 'var2', 'var3']
```
## Reading Data from Files
The Script class provides two convenience methods for reading data from files:
* `load_yaml`
* `load_json`
These two methods will load data in YAML or JSON format, respectively, from files within the local path (i.e. `SCRIPTS_ROOT`).
## Logging
The Script object provides a set of convenient functions for recording messages at different severity levels:
@ -73,7 +82,7 @@ The Script object provides a set of convenient functions for recording messages
* `log_warning`
* `log_failure`
Log messages are returned to the user upon execution of the script.
Log messages are returned to the user upon execution of the script. Markdown rendering is supported for log messages.
## Variable Reference
@ -87,6 +96,10 @@ Stores a string of characters (i.e. a line of text). Options include:
Note: `min_length` and `max_length` can be set to the same number to effect a fixed-length field.
### TextVar
Arbitrary text of any length. Renders as multi-line text input field.
### IntegerVar
Stored a numeric integer. Options include: