Configuration Object - Object Definition

This panel enables you to define the specifications of the Configuration Object. The settings on this panel depend on the type of Configuration Object that you are defining — whether a Server Object (Custom Configuration Object), Extended Object, or Configuration File. 

Server Object field

Field or GUI elementDescription
Implementation .zip fileThe ZIP file that you want to use as your custom configuration object (or custom server object).

Extended Object fields

Field or GUI elementDescription
NameA name for the extended object
DescriptionAn optional description for the extended object
Operating Systems

The class of OS to which this extended object applies

If you want to create an extended object that is associated with an object that does not have a BMC Server Automation RSCD agent installed, select None. If you select None, the Application Server must centrally execute the script or program associated with this extended object

Icon

An icon to associate with this extended object.

To populate this list with choices, you must create an icon library (see Defining custom icons). If you select Default from this list, the standard icon for extended objects is associated with the extended object you are defining.

Command/Script

A command that the extended object should run. Enter your command or enter (or specify by browsing) a path to the program or script that contains this information for the extended object.

When entering a path, you can include one or more parameters. You can enter a parameter manually, or you can click Select Property . Using parameters, you can enter a path such as /??TARGET.WINDIR??/system32/$$TARGET.SCRIPT_DIR??/script.bat. When the script runs, the system replaces the parameters with the value of the server properties WINDIR and SCRIPT_DIR. If you are defining a local extended object for a component template, use the local properties of the component template to make the path applicable to multiple instances of the same component on a server.

Note

If any of the characters shown below are included in a command, they could potentially be interpreted as delimiters within a compound shell command. To prevent this, if any of these characters appear without being escaped or enclosed within quotes, BMC Server Automation treats the entire entry as a single string, as if it was enclosed in quotation marks.
; & | > < ( )

For execution of the script or program, select one of the following options:

  • Central Execution — Executes the script or program on the Application Server. The script or program must be available in the path or explicitly qualified with the path so that the Application Server can successfully invoke it.
  • Remote Execution — Executes the script or program on a remote server using a Network Shell nexec (or equivalent) command. The script or program must be available in the path or explicitly qualified with the path so that the agent on the remote server can successfully invoke it.

Example

An extended object named Unix Services, provided out-of-the-box in BMC Server Automation, generates a report on the current status of UNIX services. The command in this extended object uses scriptutil to run the unix_svcs_status script, which resides in NSH/share/sensors, the default location of scripts executed by scriptutil. The defined command is:

scriptutil -d "??TARGET.STAGING_DIR??" -h ??TARGET.NAME?? -s unix_svcs_status

Character encoding

The mode of character encoding to use with the extended object, one of the following:

  • Select Output uses default encoding on executing system to use the default character encoding for the system where the extended object is generating output.
  • Select Output uses encoding and then select the type of character encoding that is used when displaying the output of the extended object. For example, you might select UTF8 or UTF16.
Grammar fileThe type of grammar that can process output generated by the script you specified in the Command/Script field. For more information, see Grammar files supported by BMC Server Automation.

Note

A global configuration object defined in the Configuration Object Dictionary must not conflict with a local configuration object created within any component template. You are not allowed to save your extended object in the Configuration Object Dictionary if an extended object with the same name and operating system already exists in any component template. Similarly, you are not allowed to save your component template after creating a local extended object with the same name and operating system as any extended object that already exists in the Configuration Object Dictionary. 

Configuration File fields

Field or GUI elementDescription
Operating SystemsThe class of OS to which this configuration file applies
Add multiple files (wildcarded File path) from serverTo add one or more new configuration files using wild cards in a file path, select this check box. Then, from the drop-down list to the right, select the server with the file path you are specifying.
File path

To specify the file path for the configuration file, do one of the following:

  • If you are adding a single file, enter the path to the file or use Browse to navigate to the file.
  • If you are using the wild card approach, enter the path to a directory or use Browse to navigate to the directory containing configuration files. Then use a wild card to identify multiple files in that directory. When entering a path, you can include one or more parameters. For example, you can enter $$TARGET.PATH??/??TARGET.CONFIG_DIR??/.xml* to add all the XML files at a location identified by the combination of the TARGET.PATH and the TARGET.CONFIG_DIR properties. You can enter a parameter manually, or you can click Select Property .

    If you are defining a local configuration object for a component template, use the local properties of the component template to make the path applicable to multiple instances of the same component on a server.
File encoding

The mode of character encoding to use with the configuration file, one of the following:

  • Select Uses default character encoding to use your system's default character encoding when displaying the configuration file.
  • Select Uses encoding and then select the type of character encoding that is used when displaying the configuration file. For example, you might select UTF8 or UTF16.
Grammar fileThe type of grammar used to parse the files that you are adding. For more information, see Grammar files supported by BMC Server Automation.
Was this page helpful? Yes No Submitting... Thank you

Comments