How to Change the Maximum Run Time for a Program
Applies To: System Center 2012 Configuration Manager, System Center 2012 Configuration Manager SP1, System Center 2012 R2 Configuration Manager
The following example shows how to modify a program, in System Center 2012 R2 Configuration Manager, by using the SMS_Package and SMS_Program classes and properties.
Important
Any advertised program fails to run when the maintenance windows defined on the client computer are set for a period that is less than that program's Maximum allowed run time setting. See the topic "Program Run Scenario Using Maintenance Windows" in the Configuration Manager documentation for more information.
To change the maximum run time for a program
Set up a connection to the SMS Provider.
Query for the programs associated with the existing package ID provided.
Enumerate through the programs until a match for the program name is found.
Replace the program maximum run time property with the one passed into the method.
Save the program object and properties.
Example
The following example method changes the maximum run time for an existing program.
Note
A slight variation of this example could change property values for all of the programs associated with a specific package. For an example, see the How to List All Programs and Their Maximum Run Time Value code example. However, for a more efficient method of accessing a specific program, using the PackageID and ProgramName, see the How to Modify Program Properties code example.
For information about calling the sample code, see Calling Configuration Manager Code Snippets.
Sub ModifyProgram(connection, existingpackageID, existingProgramNameToModify, newMaxRunTime)
Const wbemFlagReturnImmediately = 16
Const wbemFlagForwardOnly = 32
Dim query
Dim programsForPackage
Dim program
' Build a query to get the programs for the package.
query = "SELECT * FROM SMS_Program WHERE PackageID='" & existingPackageID & "'"
' Run the query.
Set programsForPackage = connection.ExecQuery(query, , wbemFlagForwardOnly Or wbemFlagReturnImmediately)
' The query returns a collection that needs to be enumerated.
For Each program In programsForPackage
' If a match for the program name is found, make the change(s).
If program.ProgramName=existingProgramNameToModify Then
' Replace the existing package property (in this case the package description).
program.Duration = newMaxRunTime
' Save the program with the modified properties.
program.Put_
' Output program name.
wscript.echo "Modified program: " & program.ProgramName
Exit For
End If
Next
End Sub
public void ModifyProgram(WqlConnectionManager connection, string existingPackageID, string existingProgramNameToModify, int newMaxRunTime)
{
try
{
// Build query to get the programs for the package.
string query = "SELECT * FROM SMS_Program WHERE PackageID='" + existingPackageID + "'";
// Load the specific program to change (programname is a key value and must be unique).
IResultObject programsForPackage = connection.QueryProcessor.ExecuteQuery(query);
// The query returns a collection that needs to be enumerated.
foreach(IResultObject program in programsForPackage)
{
// If a match for the program name is found, make the change(s).
if (program["ProgramName"].StringValue == existingProgramNameToModify)
{
// Replace the existing package property (in this case the package description).
program["Duration"].IntegerValue = newMaxRunTime;
// Save the program with the modified properties.
program.Put();
// Output program name.
Console.WriteLine("Modified program: " + program["ProgramName"].StringValue);
}
}
}
catch (SmsException ex)
{
Console.WriteLine("Failed to modify the program. Error: " + ex.Message);
throw;
}
}
The example method has the following parameters:
Parameter |
Type |
Description |
|
---|---|---|---|
connection swbemServices |
|
A valid connection to the SMS Provider. |
|
existingPackageID |
|
The ID of an existing package with which to associate the program. |
|
existingProgramNameToModify |
|
The name for the program to modify. |
|
newMaxRunTime |
|
New approximate duration, in minutes, of program execution on the client computer. |
Compiling the Code
The C# example requires:
Namespaces
System
Microsoft.ConfigurationManagement.ManagementProvider
Microsoft.ConfigurationManagement.ManagementProvider.WqlQueryEngine
Assembly
adminui.wqlqueryengine
microsoft.configurationmanagement.managementprovider
mscorlib
Robust Programming
For more information about error handling, see About Configuration Manager Errors.
See Also
Configuration Manager Software Distribution
Software Distribution Packages
Software Distribution Programs