Policy Objects for Scripts

Returns the source object for the defined source and metric. Measurement type sources must use a separate source for each metric.

To improve performance, assign the source object to a variable instead of using the Source method every time it is needed.

Returns the source object instance of the source defined by the expression. This source object is identical to the object returned by the Policy.Source method, but because it does not have to be configured in the policy, it can be used for scheduled tasks, as well as for measurement threshold policies. The expression can have the following format depending on which component the performance metric will be collected from:

• NTPERFMON\\Object\\Counter\\Instance

  Access a perflib metric (not supported on UNIX nodes). Object, Counter, and Instance are strings as specified in the current monitor configuration for NT performance monitors.

  Example: NTPERFMON\\Process\\Elapsed Time\\*

• SNMP\\object id[\\hostname]

  Perform an SNMP get on the specified object id (OID). By default, the collection will be done on the managed node but can be elsewhere if the optional hostname is given. For SNMP, the method will have to wait until the value is returned which might take some time

  Example: SNMP\\.1.3.6.1.2.1.1.7.0\\onion.veg.com

• PROGRAM\\command[\\monname]

  Run the specified command or script for gathering the monitored value. The command or script must at some point run the opcmon command to return the value associated with the monitor. If no monitor name is specified, then the default DynPROGRAM must be used. For example, to specify the monitor mymonname: opcmon mymonname=value; to specify the default, opcmon DynPROGRAM=value.

  Examples:
  PROGRAM\\opcmon DynPROGRAM=12
PROGRAM\\opcmon testmon=25\\testmon

• EXTERNAL[\\monname]

  Wait for a value returned by the execution of the opcmon command. This is similar to the PROGRAM expression but a command is not directly carried out. An external command previously triggered by the ExecuteCommand object must provide the monitor value. The default value is DynEXTERNAL (opcmon DynExternal=10)

  Examples:
  EXTERNAL
EXTERNAL\\testmon

• WBEM\\namespace\\class name\\property name

  WMI interface (not supported on UNIX nodes). Get access to WBEM values. Namespace, class name and property name are strings as specified in the current monitor configuration for WBEM.

  Example: WBEM\\ROOT\CIMV2\\Win32_PerfRawData_PerfDisk_LogicalDisk\\DiskReadBytesPersec

• CODA\\data source\\collection\\metric name

  Query a metric from the embedded performance component. Data source, collection and metric name are strings as specified in the monitor configuration for the embedded performance component. Currently if the data source is empty, the string Coda will be used.

  Example: CODA\\\\CPU\\BYCPU_CPU_TOTAL_UTIL

  You can view a of list of available metrics in the Performance Agent Dictionary of Operating System Performance Metrics which is available at Software Product Manuals. (Select the product Performance Agent, the required version, OS, and language.)

In Perl, the backslash character '\' is an escape code. A backslash is only introduced in a string when preceded by another backslash. Because of this, tokens in expressions need to be separated by quadruple backslashes '\\\\'. Example for Perl: my $TestSource = $Policy->SourceEx("PROGRAM\\\\/tmp/script.sh\\\\testmon");

• expression: (An embedded performance component metric in the format:
  CODA\\data source\\collection\\metric name[\\category])
  
• sourceobj: (Any valid source object)

• expression: An embedded performance component metric in the format:
  CODA\\data source\\collection\\metric name.
  

• rangeofseconds: The number of seconds for which metrics should be returned.
  

• endtime: End time for rangeofseconds. The format of time is of type DATE for VB Script or a string (format DD/MM/YYYY HH:MM:SS) for Perl. The date is optional.

  Perl example for endtime:

  my $currentDate = time();
  my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) 
  = localtime($currentDate);
  my $currentDateStr = sprintf("%02d/%02d/%d %02d:%02d:%02d", 
  $mday, $mon+=1,$year+=1900,$hour,$min,$sec);

  You can then use $currentDateStr as endtime.

Returns the source object containing all values collected by the specified embedded performance component metric. For each instance, all metrics collected between the expression "endtime - rangeofseconds" and "rangeofseconds" will be returned. If endtime is 0 (NULL for Perl) it is evaluated with the current time. Example: Policy.SourceCollection ("CODA\\\\CPU\\BYCPU_CPU_TOTAL_UTIL",300,0)The number of seconds specified should usually be less than 3600 (one hour), since retrieving a large number of values takes time and consumes resources.

Adds the instance name to the source object and sets the value. If this instance is already part of the source object, the new instance will not be added and the value will be replaced. This method can be used on a newly created object or an object retrieved from any method returning a source object. This method is used to store data into the embedded performance component.

VB Script example:

set Sourceobj = Policy.CreateObject
   ("Ito.OvEpScriptMetric")
Sourceobj.Add "a:",10
Sourceobj.Add "b:",25
Policy.StoreCollection "CODA\\floppy
   \\disk\\space\\\\gauge",Sourceobj

Perl example:

my $Sourceobj = new Source;
$Sourceobj->Add("a:",10);
$Sourceobj->Add("b:",25);
$Policy->StoreCollection("CODA\\\\floppy
   \\\\disk\\\\space\\\\gauge",$Sourceobj);