Enginebuilder.py
What it does
- Creates the
engine.conf
files that are used by the Perl modules to define what data to collect from your VMware environment. - Checks your login credentials on your vCenter server and ESX/i hosts.
- Splits up your
engine.conf
files depending on the number of FA OVA files you have and/or what your VM-to-host ratio is.
Where it is
The enginebuilder.py
file is located in the $SPLUNK_HOME/etc/apps/Splunk_TA_vmware/bin
directory.
You must run enginebuilder.py
from $SPLUNK_HOME/etc/apps/Splunk_TA_vmware/local.
For example:
../bin/enginebuilder.py <arguments>
Prerequisites
1. Copy engine.template
from $SPLUNK_HOME/etc/apps/Splunk_TA_vmware/default
to $SPLUNK_HOME/etc/apps/Splunk_TA_vmware/local
.
2. Modify the engine.template
file in the local
directory.
3. Run the enginebuilder.py
script using the splunkadmin login.
engine.template examples
Here is an example engine.template
file that generates configurations using only the specified ESX/i hosts:
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
Here is an example engine.template
file that generates configs using all of the ESX/i hosts found in VC:
vcuser=splunkuservc vcpwd=splunkuser123 vc=vc1.company.com hostuser=splunksvc hostpwd=splunkuser123 host_csv=* perfInstanceData=OFF
Arguments
-c
- Run a credentials check on the user names and passwords provided for vCenter server and ESX/i host(s) in your
engine.template
. Note: Do not use this argument if you are going to runcredentials.pl
.
-l
- Limit the number of hosts per performance
engine.conf
file, such that each performanceengine.conf
file is configured to 300 VMs. That is, if you have 30 VMs per host and 20 hosts (600 VMs), then you need to type-l 10
so that each performanceengine.conf
file applies to 300 VMs.
Run enginebuilder.py
with the -h
help parameter to see all the available arguments:
../bin/enginebuilder/py -h
How to run the tool
First, modify engine.template
as needed in the $SPLUNK_HOME/etc/apps/local
directory.
../bin/enginebuilder.py -c
- Use if you have only one FA.
../bin/enginebuilder.py -c -l 10
- Use if you are going to limit the performance
engine.conf
files to 10 hosts each.
Troubleshooting
If there are credential check errors:
1. Check your user names and passwords and ensure that you can connect to the VCs and hosts using those credentials.
2. Ensure you have DNS configured for the FA.
3. Ensure you are on the same subnet as the vCenter server and ESX/i hosts.
4. Ensure this FA OVA has a unique IP address.
5. Ensure 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, 1.0.1
Feedback submitted, thanks!