OverrideableParameter (ProbeActionModuleType)

System Center

Updated: August 10, 2011

Applies To: Operations Manager 2007 R2, System Center Operations Manager 2007

Represents an overrideable configuration parameter in a monitor or module type definition.


<OverrideableParameter ID=”ParameterID” ParameterType=”dataType” Selector=”$Config/ParameterID”/>

The following sections describe attributes, child elements, and the parent element of the OverrideableParameter element.

Attributes

 

Attribute Description

ID

Required attribute. Represents the ID of the overrideable parameter. Must be unique within the module or monitor type definition.

Comment

Optional attribute. Represents commentary by the management pack author.

ParameterType

Required attribute. Represents the simple data type of the parameter to be overridden. Only simple types can be overridden.

Selector

Required attribute. Represents the XPath location within the schema defined in the Configuration (DataSourceModuleType) element of the parameter to be overridden.

ParameterType Attribute Values

 

Value Description

int

The overrideable parameter is of an integer type.

decimal

The overrideable parameter is of a decimal type.

double

The overrideable parameter is of a double type.

string

The overrideable parameter is of a string type.

datetime

The overrideable parameter is of a datetime type.

guid

The overrideable parameter is of a GUID type.

bool

The overrideable parameter is of a Boolean type.

Child Elements

None.

Parent Elements

 

Element Description

OverrideableParameters (ProbeActionModuleType)

Contains any overrideable configuration parameters of a monitor or module type definition.

Because parameter overrides are displayed in the console so that users can implement the overrides, it is advised to supply a display string for each override. For more information, see DisplayStrings.

The following sample shows how to define an OverrideableParameter element within a WriteActionModuleType module definition.

A management pack that implements this write action module type may hard code the ServiceName parameter in one of its workflows. Because ServiceName is an OverrideableParameter element, the customer can override whatever value may be set by the management pack author. If you want to implement a module type but do not want to offer its defined OverrideableParameter elements to the customer, you must write your own module type without the override definition.


<WriteActionModuleType ID="Microsoft.Windows.ServiceControlManager.StartService" Accessibility="Public">
  <Configuration>
    <xsd:element name="ComputerName" type="xsd:string" />
    <xsd:element name="ServiceName" type="xsd:string" />
  </Configuration>
  <OverrideableParameters>
    <OverrideableParameter ID="ComputerName" ParameterType="string" Selector="$Config/ComputerName$" />
    <OverrideableParameter ID="ServiceName" ParameterType="string" Selector="$Config/ServiceName$" />
  </OverrideableParameters>
  <ModuleImplementation>
    <Composite>
      <MemberModules>
        <WriteAction ID="StartService" TypeID="System!System.CommandExecuter">
          <ApplicationName><![CDATA[%WinDir%\System32\sc.exe]]></ApplicationName>
          <WorkingDirectory />
          <CommandLine>\\$Config/ComputerName$ start $Config/ServiceName$</CommandLine>
          <TimeoutSeconds>60</TimeoutSeconds>
          <RequireOutput>true</RequireOutput>
        </WriteAction>
      </MemberModules>
      <Composition>
        <Node ID="StartService" />
      </Composition>
    </Composite>
  </ModuleImplementation>
  <OutputType>System!System.CommandOutput</OutputType>
  <InputType>System!System.BaseData</InputType>
</WriteActionModuleType>

 
Show: