package_itsi_module.py

This script validates and generates a compressed package of module objects. All errors and warnings are provided as console output.

    Note  Before you run this script, restart Splunk Enterprise or open http://<host:mport>/debug/refresh in your web browser to clear the cache of any artifacts.

CLI usage

OptionRequired?DefaultDescription
--server servernameThe Splunk server name.
--user usernameThe Splunk user name.
--password passwordThe Splunk password.
--scheme http|httpshttpsThe scheme for the splunkd management port.
--port port8089The splunkd management port.
--module-name modulenameThe name of the module package. This name cannot contain spaces.
This option generates a new package directory under $SPLUNK_HOME/etc/apps/DA-ITSI-modulename.
For example, "--module-name 'OS-Host'" creates a package called DA-ITSI-OS-Host.
--output outputpathcurrent pathThe output path of the package.
--overwrite-existing-packageOverwrites an existing package.

 

CLI example

At the command line, navigate to the $SPLUNK_HOME directory and enter the following command:

./bin/splunk cmd python etc/apps/SA-ITOA/bin/itsi_module_cli/package_itsi_module.py --server localhost --user admin --password changeme --module-name SomeModule --overwrite-existing-package