Skip to content
CA Client Automation - 14.0
Documentation powered by DocOps

Default.ini

Last update December 23, 2015

The default.ini describes the OS Installation Manager parameters that are used in an OS image and the default settings for these parameters. The file is a UTF-8 coded file, so edit with UTF-8 enabled editors only e.g. Notepad. The file has an .ini file structure. The file shows the following sections:

  • Locale Section
  • Default Section
  • Reserved Section
  • Parameter Sections
  • locale
    The code page 3 indicates that this file is a UTF-8 file.
  • default
    This section contains the default settings for the parameters. The entries use the following format:

parameterName >= defaultValue

  • reserved
    This section lists some names that should not be used as OS Installation Manager parameter names. The entries of the section use the following format:
    name=parameter

Default.Ini Parameters

The default.ini parameter sections have the following structure:

[parametername] Type={ Text|Pwd|IP|Num|BootImage|OSImage|Mac|MapList|MapListExt|TextList| TextListExt}

The remaining entries of a parameter definition section and their ranges depend on the parameter type (Type=).

Text Parameter

Provides any simple text string. The length of the string can be limited by the MaxLength attribute. The following parameter attributes are valid for this parameter type:

Attribute Meaning Range
MaxLength Maximum length of the strings to be assigned 1 to 255 characters
Comment Comment on the parameter any string
Trans Drives the inheritance of parameter settings {yes|no}
UpdateDefault Overwrites the default value when updating the image {yes|no}

Password Parameter

Provides an encoded password. The password can be limited to MaxLength characters. A password is always related to a user ID. The following parameter attributes are valid for this parameter type:

Attribute Meaning Range
MaxLength Maximum length of the password to be assigned 1 to 255 characters
Comment Comment on the parameter any string
Trans Drives the inheritance of parameter settings {yes|no}
UpdateDefault Overwrites the default value when updating the image {yes|no}

IP Parameter

Specifies an IP address of the format a.b.c.d where each a...d represents an integer value between 0 and 255. The following parameter attributes are valid for this parameter type:

Attribute Meaning Range
MaxLength Maximum length of the IP address 17 characters
Comment Comment on the parameter any string
Trans Drives the inheritance of parameter settings {yes|no}
UpdateDefault Overwrites the default value when updating the image {yes|no}

Numeric Parameter

Specifies a numeric value. The range of the value is given by the attributes MaxValue, which specifies the maximum, and MinValue, which specifies the minimum. Ensure that the value of MinValue is less than or equal to the value of MaxValue. The following parameter attributes are valid for this parameter type:

Attribute Meaning Range
MaxValue Maximum of the value assigned -2147483648 to 2147483647
MinValue Minimum of the value assigned -2147483648 to 2147483647 and MinValue <= MaxValue
Comment Comment on the parameter any string
Trans Drives the inheritance of parameter settings {yes|no}
UpdateDefault Overwrites the default value when updating the image {yes|no}

Boot Image Parameter

Attribute Meaning Range
MaxLength Maximum length of the boot image name 1 to 32 characters
Comment Comment on the parameter any string
Trans Drives the inheritance of parameter settings {yes|no}
UpdateDefault Overwrites the default value when updating the image {yes|no}

OS Image Parameter

Specifies the name of an operating system image. The following parameter attributes are valid for this parameter type:

Attribute Meaning Range
MaxLength Maximum length of the operating system image name 1 to 10 characters
Comment Comment on the parameter any string
Trans Drives the inheritance of parameter settings {yes|no}
UpdateDefault Overwrites the default value when updating the image {yes|no}

Mac Parameter

Specifies a MAC address of the format ab.cd.ef.gh.ij.kl, where each a...l represents a hexadecimal digit (0-9, a-f). The following parameter attributes are valid for this parameter type:

Attribute Meaning Range
MaxLength Maximum length of the IP address 12 characters
Comment Comment on the parameter any string
Trans Drives the inheritance of parameter settings {yes|no}
UpdateDefault Overwrites the default value when updating the image {yes|no}

Mapping List / Mapping List Extended Parameter

Specifies a list of item=<string1> <string2>. String2 is shown in the editor only, when string1 has been assigned a value.

The parameter editor can extend parameters of type MapListExt, but not of type MapList.

When assigning a value to a parameter, it can only be a string that is appearing in the list.

The following parameter attributes are valid for these parameter types:

Attribute Meaning Range
MaxLength Maximum length of a list entry 1 to 255 characters
Comment Comment on the parameter any string
Trans Drives the inheritance of parameter settings {yes|no}
UpdateDefault Overwrites the default value when updating the image {yes|no}
Item Specifies a list item. This attribute can occur more than once. "string1" "string2"

Text List / Extended Text List Parameter

TextListExt specifies a list of item=<string>; that is, it is the same as a TextList parameter, but the list can be extended with the parameter editor later on.

The following parameter attributes are valid for this parameter type:

Attribute Meaning Range
MaxLength Maximum length of a list entry 1 to 255 characters
Comment Comment on the parameter any string
Trans Drives the inheritance of parameter settings {yes|no}
UpdateDefault Overwrites the default value when updating the image {yes|no}
Item Specifies a list item. This attribute can occur more than once. any string

UpdateDefault

The RegisterOSImage command provides an option to overwrite the default values of the parameters in the database. For the overwrite operation to be successful, you must set the UpdateDefault attribute of the parameter to Yes; Otherwise, the default value are not overwritten. The following RegisterOS command overwrites the default values:

RegisterOSImage  - i <image_name> -s <manager> -e [-b]

Trans Attribute

Drives the parameters settings when an operating system image is assigned to a target. When an operating system image has a predecessor image (Current or Scheduled configuration) for the target in question, a parameter of the new image also occurs in the old image, and both parameters are of the same type, then the parameter of the new image inherits the parameter setting from the predecessor configuration provided that the Trans attribute of the parameter at the new image has been set to yes. In any other case, the parameter of the new image is set to its default, if there is any, or it remains unset.

Example: Add OSIM OS Image Parameters

Explanation of localeID in default.ini

The parameter created is an Extendable Map List (Type=MapListExt). The item values have a maximum length of 128 bytes (MaxLength=128). When the OSIM OS image is assigned to a target computer, the value of this parameter can be inherited from the scheduled configuration or the current configuration (Trans=yes).

The example contains entries for Chinese Macau, Danish, English US, English UK, and French Standard.

If you did not define special properties of [localeID] in the default.ini, registerosimage will add default properties:

[localeID]
 Type=Text
 MaxLength=255
 Trans=yes
 Comment=CAMENU\xxxx

Using this specification, the parameter presents a text field (Type=Text) of size 255 (MaxLength=255). It can also inherit values from predecessor configurations (Trans=yes). The comment specifies the location of the file where the parameter has first been detected.

Do not omit the dollar characters ($) before and after the parameter name. They are mandatory.
Was this helpful?

Please log in to post comments.