Options

Edit online

Template DSL "1.2"

With template DSL version "1.2", you can add the options: section, in which you specify parameters that modify how Command Central processes a template at the time of applying the template.

Syntax 
alias: MyTemplate
dslVersion: "1.2"

options:  
  abortOnConfigFailure: true | false   #OPTIONAL  
  abortOnLayerStartupFailure: true | false   #OPTIONAL  
  forceRestartWhenDone: true | false   #OPTIONAL  
  startupLayers: true | false   #OPTIONAL

Based on the value of the abortOnConfigFailure parameter, Command Central determines whether to stop applying the template after the template fails to apply a product configuration:

  • abortOnLayerStartupFailure: true Command Central fails the template application with ERROR status if a run-time component in a layer does not start. Command Central logs an error message in the default.log, which indicates the ID(s) and status of the run-time component(s) that failed to start.
  • abortOnLayerStartupFailure: false (default) When starting a run-time component in a layer fails, the template reports a WARNING status. Command Central continues applying the template without interruption. The message in the Command Central default.log indicates the ID(s) and status of the run-time component(s) that failed to start.

If template application fails when abortOnConfigFailure: true and/or abortOnLayerStartupFailure: true, Command Central stops processing the current and all subsequent layers in the template. See the Actions section for details about how Command Central handles the execution of actions when a template fails with an ERROR status.

You can specify the forceRestartWhenDone parameter only when applying a template for product installation 10.3 or higher. Based on the value of this parameter, Command Central determines whether to restart all run-time components as the last step in applying the template:

  • forceRestartWhenDone: true Command Central does not restart the run-time components when applying product configurations for each layer, but forces a restart of all run-time components at the end of the template application.
  • forceRestartWhenDone: false (default) After applying product configurations for a layer, Command Central restarts only the run-time components in the layer that require a restart.

You can specify the startupLayers parameter only when applying a template for product installation 10.3 or higher. After applying a layer, Command Central determines whether to start all run-time components created for the layer as follows:

  • startupLayers: true (default) Starts the run-time components.
  • startupLayers: false Does not start the run-time components.

Note that you can specify the values of the parameters in the options: section by reference, so that you can provide the actual value at the time of applying the template (in a properties file or the command line interface): 

options:  
  abortOnConfigFailure: ${value}  
  abortOnLayerStartupFailure: ${value}  
  forceRestartWhenDone: ${value}  
  startupLayers: ${value}

Template DSL "1.1"

The template DSL versions "1.1" and "1.0" do not support the options: section and its parameters.