I figured I would post how I got this working in our environment. Sorry but some of the system calls are out to my actions. You'll need to substitute those with something of your own. If you need those I could provide for you but they are simple things like retrieving the configuration item and removing white space
1. setup a scripting host or use the vMA appliance. I am using our vMA appliance.
2. Using the SSH plugin add the host to your vCenter Orchestrator and do a key exchange.
3. I created an action to check if the host already has any SNMP settings since in our environment we only want to populate things if this is empty or we specifically tell the update action to overwrite. My action looks as follows.
var returnVal = false;
var snmpCommunities = "";
var snmpTargets = "";
var snmpEnabled = false;
try{
var keyPath = [your SSHkey path];
var keyPhrase = [your Key Phrase];
var sshHost = [Scripting host to run agains];
var sshUser = [SSH Connecting User];
var esxKey = [Depending on how you setup your script host this may not be needed];
var session = new SSHSession(sshHost,sshUser);
var cmd = "vicfg-snmp --server " + esxHost.name + " --username root --password \"" + esxKey +"\" --show";
session.connectWithPasswordOrIdentity(false,keyPhrase,keyPath);
System.log("Executing '" + cmd.replace(esxKey,"NOPASSSHOWNINLOG") + "'");
session.executeCommand(cmd,true) ;
output = session.getOutput();
error = session.getError();
exitCode = session.exitCode;
System.log("Output: '"+output+"'");
System.log("Error: '"+error+"'");
System.log("Exit code: '"+exitCode+"'");
snmpEnabled = output.indexOf("Enabled : 1") >= 0;
snmpCommunities = output.substring(output.indexOf("Communities :") + 13, output.indexOf("Notification targets :") -1);
snmpTargets = output.substring(output.indexOf("Notification targets :") + 22, output.indexOf("Options :") -1);
System.log("snmpEnabled = " + snmpEnabled);
System.log("snmpCommunities = " + snmpCommunities);
System.log("snmpTargets = " + snmpTargets);
if (snmpEnabled) {
returnVal = true;
}
if ( System.getModule("com.qualcomm.basic").QCremoveWhiteSpace(snmpCommunities).length > 0 ) {
returnVal = true;
}
if ( System.getModule("com.qualcomm.basic").QCremoveWhiteSpace(snmpTargets).length > 0 ) {
returnVal = true;
}
session.disconnect();
} catch (e) {
throw "Unable to execute command " + ereplace(esxKey,"NOPASSHOWNINLOG");
}
return returnVal;
function isBlank(str) {
return (!str || /^\s*$/.test(str));
}
4. Create an action that will do the update. I have mine set to grab the desired snmp configuration from predefined configurations. :
var returnVal = "";
var snmpCommunities = "";
var snmpTargets = "";
var keyPath = [your SSHkey path];
var keyPhrase = [your Key Phrase];
var sshHost = [Scripting host to run agains];
var sshUser = [SSH Connecting User];
var esxKey = [Depending on how you setup your script host this may not be needed];
// We keep the SNMP config type in a custom field in vCenter
var snmpConfigType =System.getModule("com.qualcomm.basic").QCgetCustomFieldValue(esxHost,"snmp_config",true);
// Checking the QCisSNMPSet action. Only want to update if this has not been tampered with by a human.
var alreadySet = System.getModule("com.qualcomm.basic").QCisSNMPSet(esxHost);
if (alreadySet && isBlank(snmpConfigType)){ // bail if no config set but host has a config
returnVal = "Aborting. Can't use default SNMP configuration. Host " + esxHost.name + " already has SNMP values set.";
System.log(returnVal);
}
else {
if (isBlank(snmpConfigType)) {
snmpConfigType = "snmpDefault";
}
var snmpConfig = System.getModule("com.qualcomm.basic").QCgetConstant("Qualcomm","SNMP",snmpConfigType);
// We keep the config in an item that is a string array. Each item is tagged with either "communites:" or "targets:"
for (i=0;i<snmpConfig.length;i++) {
if (snmpConfig[i].toLowerCase().indexOf("communities") >= 0) {
snmpCommunities = snmpConfig[i].substring(snmpConfig[i].indexOf(":") + 1);
}
if (snmpConfig[i].toLowerCase().indexOf("targets") >= 0) {
snmpTargets = snmpConfig[i].substring(snmpConfig[i].indexOf(":") + 1);
}
}
try{
var session = new SSHSession(sshHost,sshUser);
var cmd = "vicfg-snmp --server " + esxHost.name + " --username root --password \"" + esxKey +"\" --enable -t " + snmpTargets + " -c " + snmpCommunities;
session.connectWithPasswordOrIdentity(false,keyPhrase,keyPath);
System.log("Executing '" + cmd.replace(esxKey,"NOPASSHOWNINLOG") + "'");
session.executeCommand(cmd,true) ;
output = session.getOutput();
error = session.getError();
exitCode = session.exitCode;
System.log("Output: '"+output+"'");
System.log("Error: '"+error+"'");
System.log("Exit code: '"+exitCode+"'");
session.disconnect();
returnVal = "Updated " + esxHost.name + " with the SNMP config type: " + snmpConfigType;
} catch (e) {
throw "Unable to execute command " + e.replace(esxKey,"NOPASSHOWNINLOG");
}
}
return returnVal;
function isBlank(str) {
return (!str || /^\s*$/.test(str));
}
