HP Insight Control Server Provisioning 7.3 Update 1 Administrator Guide

8 Using custom attributes
About custom attributes
A custom attribute is a simple name/value pair you define, that is used as a form of variable
substitution in scripts, configuration files, parameters, and other appliance functions. When
referenced, the custom attribute name is replaced by the value of that custom attribute. Custom
attributes do not stand alone; they are always associated with an object in the management
database, such as servers, device groups, facility, or OS Build Plans. See the Insight Control Server
Provisioning Build Plans Reference Guide for more information on the custom attributes used in
HP-provided Build Plans.
Custom attributes substitute specific values into scripts, configuration files, and package paths when
a Build Plan is run. This is useful for configuring installation processes, including network and server
configuration. Custom attributes are typically used for overriding default values.
For example, when using custom attributes in script code, use the format:
@name@
or
@name:default_value@
where name is the custom attribute name and default_value is the value that will be used if
this custom attribute is not found in the appliance database. Defining a default value is optional.
Examples of custom attributes in scripts:
• If a custom attribute is defined using the UI as name MediaServer and value 10.1.1.2,
you may reference it in a script with @MediaServer@. When the OS Build Plan is run on a
server, @MediaServer@ will be replaced with 10.1.1.2.
• If your script contains the code @Password:ChangeMe123!@ and the custom attribute
Password is not defined via the UI, when the Build Plan is run the custom attribute Password
is not found in the appliance database so Password will be replaced with ChangeMe123!.
Custom attributes can be inherited from a containing object. For example, a server in a device
group will inherit the custom attributes from that device group. See “Rules for custom attributes”
(page 39).
Custom attributes may be defined in the UI as follows:
• For a specific server use the Edit Servers screen.
• For a device group use the Edit Device Groups screen.
• For a specific Build Plan use the Edit OS Build Plans screen.
• System wide (default value) facility custom attributes may be viewed and edited from the
Settings screen by selecting Edit on the Facility Custom Attributes panel.
See “Table of some commonly used custom attributes” (page 40) for a list of some commonly used
custom attributes.
For a list of custom attributes used in the HP-provided Build Plans, see the Insight Control Server
Provisioning Build Plans Reference Guide. You can, of course, define your own custom attributes
(see “Creating your own custom attributes” (page 40)).
Rules for custom attributes
Custom attributes must conform to the following rules:
• The name may not contain spaces or special characters. It may contain numbers, underscores,
and dashes.
About custom attributes 39