snmp.xml revision 75e789577e089751d395faac10873e0285bf3a54
59190ecd61435d19ba3515b876272aee7bd12298vboxsync<?xml version="1.0" encoding="UTF-8" standalone="no"?>
59190ecd61435d19ba3515b876272aee7bd12298vboxsync ! CDDL HEADER START
59190ecd61435d19ba3515b876272aee7bd12298vboxsync ! The contents of this file are subject to the terms of the
c58f1213e628a545081c70e26c6b67a841cff880vboxsync ! Common Development and Distribution License, Version 1.0 only
59190ecd61435d19ba3515b876272aee7bd12298vboxsync ! (the "License"). You may not use this file except in compliance
c55c68b6a3324172e9dc207926215845880b0f90vboxsync ! with the License.
c55c68b6a3324172e9dc207926215845880b0f90vboxsync ! You can obtain a copy of the license at
c55c68b6a3324172e9dc207926215845880b0f90vboxsync ! trunk/opends/resource/legal-notices/OpenDS.LICENSE
c55c68b6a3324172e9dc207926215845880b0f90vboxsync ! See the License for the specific language governing permissions
c55c68b6a3324172e9dc207926215845880b0f90vboxsync ! and limitations under the License.
59190ecd61435d19ba3515b876272aee7bd12298vboxsync ! When distributing Covered Code, include this CDDL HEADER in each
59190ecd61435d19ba3515b876272aee7bd12298vboxsync ! file and include the License file at
59190ecd61435d19ba3515b876272aee7bd12298vboxsync ! trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
59190ecd61435d19ba3515b876272aee7bd12298vboxsync ! add the following below this CDDL HEADER, with the fields enclosed
59190ecd61435d19ba3515b876272aee7bd12298vboxsync ! by brackets "[]" replaced with your own identifying information:
59190ecd61435d19ba3515b876272aee7bd12298vboxsync ! Portions Copyright [yyyy] [name of copyright owner]
59190ecd61435d19ba3515b876272aee7bd12298vboxsync ! CDDL HEADER END
59190ecd61435d19ba3515b876272aee7bd12298vboxsync ! Copyright 2008 Sun Microsystems, Inc.
59190ecd61435d19ba3515b876272aee7bd12298vboxsync <!-- SNMP Get -->
df294ff29aab74013667896ef2d4f5bd1f782143vboxsync This function performs a SNMP get request
59190ecd61435d19ba3515b876272aee7bd12298vboxsync type="optional"
59190ecd61435d19ba3515b876272aee7bd12298vboxsync default="STAF_REMOTE_HOSTNAME">
df294ff29aab74013667896ef2d4f5bd1f782143vboxsync Location of target host
df294ff29aab74013667896ef2d4f5bd1f782143vboxsync <function-arg-property name="type" value="hostname"/>
df294ff29aab74013667896ef2d4f5bd1f782143vboxsync <function-arg-def name="snmpVersion" type="required">
df294ff29aab74013667896ef2d4f5bd1f782143vboxsync SNMP request version
df294ff29aab74013667896ef2d4f5bd1f782143vboxsync <function-arg-property name="type" value="version" />
df294ff29aab74013667896ef2d4f5bd1f782143vboxsync type="optional"
df294ff29aab74013667896ef2d4f5bd1f782143vboxsync default="STAF_REMOTE_HOSTNAME">
59190ecd61435d19ba3515b876272aee7bd12298vboxsync Directory server SNMP hostname or IP address
59190ecd61435d19ba3515b876272aee7bd12298vboxsync <function-arg-property name="type" value="hostname" />
df294ff29aab74013667896ef2d4f5bd1f782143vboxsync Directory server SNMP port number
df294ff29aab74013667896ef2d4f5bd1f782143vboxsync <function-arg-property name="type" value="Port number"/>
df294ff29aab74013667896ef2d4f5bd1f782143vboxsync SNMP OID to query
59190ecd61435d19ba3515b876272aee7bd12298vboxsync <function-arg-property name="type" value="string"/>
59190ecd61435d19ba3515b876272aee7bd12298vboxsync <function-arg-def name="snmpCommunity" type="required">
df294ff29aab74013667896ef2d4f5bd1f782143vboxsync <function-arg-property name="type" value="string"/>
df294ff29aab74013667896ef2d4f5bd1f782143vboxsync SNMP user used for v3 requests
59190ecd61435d19ba3515b876272aee7bd12298vboxsync <function-arg-property name="type" value="string"/>
59190ecd61435d19ba3515b876272aee7bd12298vboxsync <function-arg-def name="snmpSecurityLevel" type="optional">
59190ecd61435d19ba3515b876272aee7bd12298vboxsync SNMP security level used for v3 requests
59190ecd61435d19ba3515b876272aee7bd12298vboxsync <function-arg-property name="type" value="string"/>
59190ecd61435d19ba3515b876272aee7bd12298vboxsync <function-arg-def name="snmpSecurityFile" type="optional">
59190ecd61435d19ba3515b876272aee7bd12298vboxsync Path to the SNMP security file
59190ecd61435d19ba3515b876272aee7bd12298vboxsync <function-arg-property name="type" value="string"/>
59190ecd61435d19ba3515b876272aee7bd12298vboxsync <function-arg-def name="snmpStatus" type="required">
59190ecd61435d19ba3515b876272aee7bd12298vboxsync Expected status of the SNMP request
59190ecd61435d19ba3515b876272aee7bd12298vboxsync <function-arg-property name="type" value="string"/>
59190ecd61435d19ba3515b876272aee7bd12298vboxsync <function-arg-def name="snmpValidOIDs" type="optional">
59190ecd61435d19ba3515b876272aee7bd12298vboxsync Check if the values returned for the OIDs are correct
59190ecd61435d19ba3515b876272aee7bd12298vboxsync <function-arg-property name="type" value="string"/>
59190ecd61435d19ba3515b876272aee7bd12298vboxsync Perform a walk request
59190ecd61435d19ba3515b876272aee7bd12298vboxsync <function-arg-property name="type" value="string"/>
59190ecd61435d19ba3515b876272aee7bd12298vboxsync <function-arg-def name="expectedRC" type="optional" default="0">
59190ecd61435d19ba3515b876272aee7bd12298vboxsync Expected return code value. Default value is 0
59190ecd61435d19ba3515b876272aee7bd12298vboxsync Wildcard 'noCheck' to not check the RC
59190ecd61435d19ba3515b876272aee7bd12298vboxsync <function-arg-property name="type" value="integer"/>
59190ecd61435d19ba3515b876272aee7bd12298vboxsync <!-- Build the command -->
59190ecd61435d19ba3515b876272aee7bd12298vboxsync STAFCmdParamsList=[]
59190ecd61435d19ba3515b876272aee7bd12298vboxsync STAFCmdParams=''
59190ecd61435d19ba3515b876272aee7bd12298vboxsync if snmpVersion:
59190ecd61435d19ba3515b876272aee7bd12298vboxsync STAFCmdParamsList.append('-v %s' % snmpVersion)
59190ecd61435d19ba3515b876272aee7bd12298vboxsync if snmpHost:
59190ecd61435d19ba3515b876272aee7bd12298vboxsync STAFCmdParamsList.append('-h %s' % snmpHost)
59190ecd61435d19ba3515b876272aee7bd12298vboxsync if snmpPort:
59190ecd61435d19ba3515b876272aee7bd12298vboxsync STAFCmdParamsList.append('-p %s' % snmpPort)
59190ecd61435d19ba3515b876272aee7bd12298vboxsync if snmpOIDs:
59190ecd61435d19ba3515b876272aee7bd12298vboxsync STAFCmdParamsList.append('-o %s' % snmpOIDs)
59190ecd61435d19ba3515b876272aee7bd12298vboxsync if snmpCommunity:
59190ecd61435d19ba3515b876272aee7bd12298vboxsync STAFCmdParamsList.append('-c %s' % snmpCommunity)
59190ecd61435d19ba3515b876272aee7bd12298vboxsync if snmpUser:
59190ecd61435d19ba3515b876272aee7bd12298vboxsync STAFCmdParamsList.append('-u %s' % snmpUser)
59190ecd61435d19ba3515b876272aee7bd12298vboxsync if snmpSecurityLevel:
59190ecd61435d19ba3515b876272aee7bd12298vboxsync STAFCmdParamsList.append('-l %s' % snmpSecurityLevel)
59190ecd61435d19ba3515b876272aee7bd12298vboxsync if snmpSecurityFile:
59190ecd61435d19ba3515b876272aee7bd12298vboxsync STAFCmdParamsList.append('-f %s' % snmpSecurityFile)
59190ecd61435d19ba3515b876272aee7bd12298vboxsync if snmpStatus:
59190ecd61435d19ba3515b876272aee7bd12298vboxsync STAFCmdParamsList.append('-s %s' % snmpStatus)
59190ecd61435d19ba3515b876272aee7bd12298vboxsync if snmpValidOIDs:
59190ecd61435d19ba3515b876272aee7bd12298vboxsync STAFCmdParamsList.append('-n %s' % snmpValidOIDs)
59190ecd61435d19ba3515b876272aee7bd12298vboxsync if snmpWalk:
59190ecd61435d19ba3515b876272aee7bd12298vboxsync STAFCmdParamsList.append('-w %s' % snmpWalk)
59190ecd61435d19ba3515b876272aee7bd12298vboxsync STAFCmdParams=' '.join(STAFCmdParamsList)
59190ecd61435d19ba3515b876272aee7bd12298vboxsync STAFCmd='SNMPGet'
59190ecd61435d19ba3515b876272aee7bd12298vboxsync if is_windows_platform(location):
59190ecd61435d19ba3515b876272aee7bd12298vboxsync separator=';'
59190ecd61435d19ba3515b876272aee7bd12298vboxsync separator=':'
59190ecd61435d19ba3515b876272aee7bd12298vboxsync opends_jarfile='%s/%s' % (DIRECTORY_INSTANCE_DIR,SNMP_OPENDS_JARFILE)
59190ecd61435d19ba3515b876272aee7bd12298vboxsync emma_jarfile='%s/%s/lib/emma.jar' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)
59190ecd61435d19ba3515b876272aee7bd12298vboxsync if os.path.exists(emma_jarfile):
59190ecd61435d19ba3515b876272aee7bd12298vboxsync cp = 'CLASSPATH=%s%s%s%s%s%s.' \
59190ecd61435d19ba3515b876272aee7bd12298vboxsync % (opends_jarfile,separator,jdmk_jarfile,separator,emma_jarfile,separator)
59190ecd61435d19ba3515b876272aee7bd12298vboxsync cp = 'CLASSPATH=%s%s%s%s.' \
59190ecd61435d19ba3515b876272aee7bd12298vboxsync % (opends_jarfile,separator,jdmk_jarfile,separator)
59190ecd61435d19ba3515b876272aee7bd12298vboxsync env = ['JAVA_HOME=%s' % JAVA_HOME, '%s' % cp]
59190ecd61435d19ba3515b876272aee7bd12298vboxsync '%s %s' % (STAFCmd, STAFCmdParams)
59190ecd61435d19ba3515b876272aee7bd12298vboxsync 'name' : 'SNMP Get' ,
59190ecd61435d19ba3515b876272aee7bd12298vboxsync 'arguments' : '%s %s' % (STAFCmd, STAFCmdParams) ,
59190ecd61435d19ba3515b876272aee7bd12298vboxsync 'location' : location ,
STAFCmdParamsList.append('-v %s' % snmpVersion)
STAFCmdParamsList.append('-h %s' % snmpHost)
STAFCmdParamsList.append('-p %s' % snmpPort)
STAFCmdParamsList.append('-o %s' % snmpOIDs)
STAFCmdParamsList.append('-c %s' % snmpCommunity)
STAFCmdParamsList.append('-u %s' % snmpUser)
STAFCmdParamsList.append('-l %s' % snmpSecurityLevel)
STAFCmdParamsList.append('-f %s' % snmpSecurityFile)
STAFCmdParamsList.append('-s %s' % snmpStatus)
STAFCmdParamsList.append('-n %s' % snmpValidOIDs)
if os.path.exists(emma_jarfile):
jstaf_jarfile='%s\\bin\\JSTAF.jar' % STAFResult
STAFCmdParamsList.append('-h %s' % snmpHost)
STAFCmdParamsList.append('-p %s' % snmpTrapPort)
STAFCmdParamsList.append('-c %s' % snmpTrapCommunity)
STAFCmdParamsList.append('-t %s' % snmpTrapNumber)
STAFCmdParamsList.append('-h %s' % dsInstanceHost)
STAFCmdParamsList.append('-p %s' % dsInstancePort)
STAFCmdParamsList.append('-D "%s"' % dsInstanceDn)
STAFCmdParamsList.append('-w "%s"' % dsInstancePswd)
STAFCmdParamsList.append('-n')
STAFCmdParamsList.append('set-connection-handler-prop')
STAFCmdParamsList.append('--handler-name "SNMP Connection Handler"')