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. Fixed documentation

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

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

@ -264,10 +264,12 @@ http://netbox/api/extras/scripts/example.MyReport/ \
Scripts can be run on the CLI by invoking the management command: 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> python3 manage.py runscript [--commit] [--loglevel {debug,info,warning,error,critical}] [--data "<data>"] <module>.<script>
``` ```
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 required ``<module>.<script>`` argument is the script 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 ``--data "<data>"`` argument is the data to send to the script
The optional ``--loglevel`` argument is the desired logging level to output to the console. The optional ``--loglevel`` argument is the desired logging level to output to the console.

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

@ -28,10 +28,10 @@ class Command(BaseCommand):
dest='loglevel', dest='loglevel',
default='info', default='info',
choices=['debug', 'info', 'warning', 'error', 'critical']) choices=['debug', 'info', 'warning', 'error', 'critical'])
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('--commit', help="Commit this script to database", action='store_true')
parser.add_argument('--user', help="User script is running as") parser.add_argument('--user', help="User script is running as")
parser.add_argument('data', help="Data as a string encapsulated JSON blob") parser.add_argument('--data', help="Data as a string encapsulated JSON blob")
parser.add_argument('script', help="Script to run")
def handle(self, *args, **options): def handle(self, *args, **options):
def _run_script(): def _run_script():
@ -69,7 +69,12 @@ class Command(BaseCommand):
script = options['script'] script = options['script']
loglevel = options['loglevel'] loglevel = options['loglevel']
commit = options['commit'] commit = options['commit']
data = json.loads(options['data']) if options['data'] is not None else None try:
data = json.loads(options['data'])
except TypeError:
data = {}
module, name = script.split('.', 1) module, name = script.split('.', 1)