create_itsi_module.py

This script generates a barebones module directory on the file system under the name DA-ITSI-modulename.

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.
--module-title labelThe title of the module. The recommended naming format for all non-Splunk-developed modules is "Module name Module for Splunk IT Service Intelligence". This title is displayed in the ITSI Module Lister.
--module-version versionThe format is a triple number (#.#.#).
--module-author authorThe author of the module. Use quotes with the name.
For example, "--module-author 'Bob Smith'".
--module-description descriptionA description of the module.
--overwrite-existing-moduleOverwrites an ITSI module, if one exists, and lose all content in the directory.

 

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/create_itsi_module.py --server localhost --user admin --password changeme --module-name OS-Host --module-title 'OS Host Module for Splunk IT Service Intelligence' --module-description 'This is an example module for ITSI' --module-author 'Splunk Docs' --module-version '1.0.0'