Running Custom Script from CLI with arguments

[dionrowney]

I have a script that I run via the GUI normally and want to run via the Linux CLI. It has 2 required arguments it takes. How do I pass those into the script at the CLI?

I have read the docs on this located here: https://netboxlabs.com/docs/netbox/customization/custom-scripts/#via-the-cli and it provides an example but does not provide an example of an argument being passed to the script being run.

When I run like I expect I get:

(venv) # python3 manage.py runscript --data '{"data": {"foo": "somevalue", "bar": 123}, "commit": true}' script_name
Traceback (most recent call last):
  File "/opt/netbox/netbox-4.3.5/netbox/manage.py", line 10, in <module>
    execute_from_command_line(sys.argv)
  File "/opt/netbox/netbox-4.3.5/venv/lib64/python3.11/site-packages/django/core/management/__init__.py", line 442, in execute_from_command_line
    utility.execute()
  File "/opt/netbox/netbox-4.3.5/venv/lib64/python3.11/site-packages/django/core/management/__init__.py", line 436, in execute
    self.fetch_command(subcommand).run_from_argv(self.argv)
  File "/opt/netbox/netbox-4.3.5/venv/lib64/python3.11/site-packages/django/core/management/base.py", line 416, in run_from_argv
    self.execute(*args, **cmd_options)
  File "/opt/netbox/netbox-4.3.5/venv/lib64/python3.11/site-packages/django/core/management/base.py", line 460, in execute
    output = self.handle(*args, **options)
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/netbox/netbox-4.3.5/netbox/extras/management/commands/runscript.py", line 40, in handle
    module_name, script_name = script.split('.', 1)
    ^^^^^^^^^^^^^^^^^^^^^^^^
ValueError: not enough values to unpack (expected 2, got 1)

What is correct way to do this?

[pheus]

Hi there!

You’re very close. That error occurs because runscript expects the script argument in the form <module>.<script>, where:

• <module> is the Python file in your scripts/ directory without the .py extension, and
• <script> is the class name of your script inside that module.

Also, the JSON you pass to --data should be only the fields your script defines. So don’t wrap them in an outer "data" key and the commit is controlled by the --commit flag (not inside the JSON).

Example:

(venv) $ python3 manage.py runscript --data '{"foo": "somevalue", "bar": 123}' --commit my_module.MyScript 

[dionrowney]

That worked. the example should be more like:

(venv) $ python3 manage.py runscript --data '{"foo": "somevalue", "bar": 123}' --commit myscriptnamewithoutthepy.classname 

thanks!!