mirror/netbox-community-netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2024-05-10 07:54:54 +00:00
Code Activity

#6529 - Adjusted the arguments. Added documentation

Browse Source
This commit is contained in:
Daniel Sheppard
2021-11-02 15:56:42 -05:00
parent b7c0e8b71f
commit 7c3318df92
2 changed files with 19 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/customization/custom-scripts.md
View File

@ -259,6 +259,20 @@ http://netbox/api/extras/scripts/example.MyReport/ \
--data '{"data": {"foo": "somevalue", "bar": 123}, "commit": true}'
```
### Via the CLI
Scripts can be run on the CLI by invoking the management command:
```
python3 manage.py runscript [--commit] [--loglevel {debug,info,warning,error,critical}] --script <module>.<script> <data>
```
The required ``--script <module>.<script>`` argument is the report to run where ``<module>`` is the name of the python file in the ``scripts`` directory without the ``.py`` extension and ``<script>`` is the name of the script class in the ``<module>`` to run.
The optional ``--loglevel`` argument is the desired logging level to output to the console.
The optional ``--commit`` argument will commit any changes in the script to the database.
## Example
Below is an example script that creates new objects for a planned site. The user is prompted for three variables:

10
netbox/extras/management/commands/runscript.py
View File

@ -28,10 +28,10 @@ class Command(BaseCommand):
dest='loglevel',
default='info',
choices=['debug', 'info', 'warning', 'error', 'critical'])
parser.add_argument('--script', help="Script to run", dest='script', required=True)
parser.add_argument('--commit', help="Commit this script to database", dest='commit')
parser.add_argument('--user', help="User script is running as", dest='user')
parser.add_argument('data', help="Data as a JSON blob")
parser.add_argument('--script', help="Script to run", required=True)
parser.add_argument('--commit', help="Commit this script to database", action='store_true')
parser.add_argument('--user', help="User script is running as")
parser.add_argument('data', help="Data as a string encapsulated JSON blob")
def handle(self, *args, **options):
def _run_script():
@ -68,8 +68,8 @@ class Command(BaseCommand):
# Params
script = options['script']
loglevel = options['loglevel']
commit = options['commit']
data = json.loads(options['data']) if options['data'] is not None else None
commit = True if options['commit'] in ['1', 'true', 'True'] else False
module, name = script.split('.', 1)