Enginebuilder.py
Run enginebuilder.py to automatically create the engine.conf
files that specify how data is collected in your VMware environment from vCenter. It reads the engine.template
file that contains key information about your environment and it can also call logincreator.pl to check service account credentials.
When you run enginebuilder.py
it:
- Checks your login credentials on the vCenter server and ESX/i hosts.
- Splits up your
engine.conf
files depending on the number of FA OVA files you have and depending upon your VM-to-host ratio.
Important: enginebuilder.py
assumes that all ESX/i hosts in the host_csv field use the same service account username and password (hostuser, hostpwd). If your ESX/i hosts do not use the same service account credentials, you can:
- run enginebuilder.py multiple times.
- generate the FA VM configuration files manually.
Reference the table for more details about the enginebuilder.py tool.
Tool name | enginebuilder.py |
---|---|
Location | $SPLUNK_HOME/etc/apps/Splunk_TA_vmware/bin
|
Prerequisites |
|
Inputs | Your engine.template file.
|
Outputs | engine.conf configuration files
|
Command line usage |
|
Arguments |
|
Examples |
Sample vcuser=splunkuservc vcpwd=splunkuser123 vc=vc1.company.com hostuser=splunksvc hostpwd=splunkuser123 host_csv=esx1.company.com,esx2.company.com,esx3.company.com perfInstanceData=OFF Sample vcuser=splunkuservc vcpwd=splunkuser123 vc=vc1.company.com hostuser=splunksvc hostpwd=splunkuser123 host_csv=* perfInstanceData=OFF |
Gather information for the engine.template file
Edit the engine.template
file to include the following information:
Setting | perfInstanceDataPerfTypeBlacklist |
---|---|
vcuser | The username for the service account created to access vCenter. |
vcpwd | The password for the vcuser (for the service account created to access vCenter). |
vc | The IP or hostname of the vCenter Server. |
hostuser | The username for the service account created to access ESX/i hosts. |
hostpwd | The password for the hostuser (for the service account created to access ESX/i hosts). |
host_csv | A comma separated list of values containing ESX/i host IPs or hostnames. You can use“*” to generate files that cover ALL of the ESX/i hosts managed by the given vCenter. |
perfInstanceData | This option is set to OFF by default. When turned ON it provides fine-grained control over the amount and kinds of performance data that you want the engine to collect |
How it works
- Edit the engine.template file with key information about your environment.
- You can include multiple VCs in the file.
- Run enginebuilder.py, which uses the
engine.template
file. enginebuilder.py
generates all of yourengine.conf
andinputs.conf
files.- It creates
engine.conf
files by data type: engine<datatype>.conf. - It creates inputs.conf with scripted inputs to start engine instances using
engine.conf
files.
- It creates
- enginebuilder.py optionally runs the service account tool (logincreator.pl) to verify service accounts
- It checks permissions on vCenter server and all ESX/i hosts
- It runs logincreator.pl to verify accounts (it does not create or modify them)
- you can run logincreator.pl by itself to create or verify logins. For more information, see Create service accounts in this manual.
Troubleshooting
If there are credential check errors, here are some things you can check to see if you can resolve them:
- Check your user names and passwords and ensure that you can connect to the vCenters and hosts using those credentials.
- Check that you have DNS configured for the FA.
- Check that you are on the same subnet as the vCenter server and ESX/i hosts.
- Check that this FA OVA has a unique IP address.
- Check that this FA has an IP address assigned to it.
Logincreator.pl | Credentials.pl |
This documentation applies to the following versions of Splunk® App for VMware (Legacy): 1.0.2, 1.0.3, 2.0
Feedback submitted, thanks!