This section contains the following topics:
Blueprint Page: Component Blueprint Fields
Discovery Methods Page: Search Options Fields
Discovery Methods Page: File Indicators Fields
Discovery Methods Page: Registry Indicators Search Options Fields
Discovery Methods Page: Registry Indicators Fields
Discovery Methods Page: Network Probe Fields
Discovery Verification Rules Page: Discovery Verification Rule Fields
Management Page: File Management Options Fields
Management Page: Directory Fields
Management Page: Directory Fields
Filters and Attributes Page Rules Tab Fields
Registry Filters and Attributes Page Add Key Fields
Registry Filters and Attributes Page Value Details Fields
Component Parameters and Variables Page Fields
Configuration - File Parsing Page
Configuration Executables Page
The Component Blueprint pane on the Blueprint wizard Blueprint page contains the following fields:
Defines a unique name for the blueprint.
Limitations: The blueprint name cannot contain the following characters: < > ; : " ' * + = \ / | ?
Defines the software component version (release number).
Default: *.*
Defines the blueprint version, in your preferred format.
Default: 1.0.0
Specifies whether discovery is enabled or disabled for the blueprint.
Default: Enabled
Describes the blueprint item. The blueprint Details page displays the description.
Specifies the operating system on which the software component runs. The operating system that you select determines whether the blueprint:
You can always add or remove operating system-specific files. However, choosing the target operating system lets you start with a more representative base blueprint structure. For example:
Default: Any
Specifies the component category under which the Component Blueprints page lists the new blueprint. Note: To separate your custom blueprints from predefined blueprints, use the Custom Components category. A separate category lets you find the blueprints easily and avoid accidentally editing the predefined blueprints.
Default: Custom Components
The Add New Search Options pane on the Blueprint wizard Discovery Methods page contains the following Search Options fields:
Defines where the search starts. If you do not set this value, the search begins at the top of the component file system.
For Windows, the top of the file system (/) includes all physical drives (C:, D:, and so on).
Default: / (root)
Defines the number of folders or directories the search includes.
Default: 10
Specifies whether the process always considers the component as discovered.
The product does not search for the indicators. If you define a $(Root) parameter as a constant, the product manages files under the root. Select Yes to define and manage components in services that the product cannot or does not need to discover.
The product searches for the indicators.
Default: No
The Add New File pane on the Blueprint wizard Discovery Methods page contains the following fields:
Defines the directory or file to discover. You can use wildcard characters (*) to define the name with the POSIX pattern-matching syntax (for example, Agent_*).
Specifies whether the product adds a File or a Directory to the blueprint.
Default: File
Note: Specify either the Path From Root field or the Depth From Root value.
Defines the partial path on which to locate the component root relative to the file indicator path. Define only the directories or folders between the file indicator and the component root (not the entire component path).
For example, the file indicator mx.ini locates the configuration file C:\Program Files\mx\setup\conf\mx.ini. To define the path C:\Program Files\mx as the component root, define the path from the root as setup\conf.
Defines the number of folders or directories the discovery includes, beginning from the search root.
The \HKEY_LOCAL_MACHINE pane on the Blueprint wizard Discovery Methods page for Registry Indicators contains the following Search Options fields:
Defines where the search starts. If you do not set this value, the search begins at the top of the component file system.
For Windows, the top of the file system (/) includes all physical drives (C:, D:, and so on).
Default: \HKEY_LOCAL_MACHINE
Defines the number of folders or directories the search includes.
Default: 10
Specifies whether the process always considers the component as discovered.
The product does not search for the indicators. If you define a $(Root) parameter as a constant, the product manages files under the root. Select Yes to define and manage components in services that the product cannot or does not need to discover.
The product searches for the indicators.
Default: No
The Add New Registry Value/Key pane on the Blueprint wizard Discovery Methods page for Registry Indicators contains the following Registry Indicators fields:
Defines the directory or file to discover. You can use wildcard characters (*) to define the name with the POSIX pattern-matching syntax (for example, Agent_*).
Specifies whether the product adds a File or a Directory to the blueprint.
Default: File
Note: Specify either the Path From Root field or the Depth From Root value.
Defines the path from the search root.
Defines the number of folders or directories the discovery includes, beginning from the search root.
The Add New Network Probe pane on the Blueprint wizard Discovery Methods page for Network Probes contains the following Network Probe fields:
Defines a name for the network probe.
Describes the blueprint item.
Defines a comma-delimited list of the first port numbers from which to collect responses.
Defines a comma-delimited list of port numbers from which to collect responses if the primary ports fail.
Describes an optional probe that is sent from CCA to the remote service after the port communications have been established. The probe is to verify that the service or component exists.
Defines the attribute that the product compares to the regular expression directive value. If the value does not match, the directive fails.
Defines the regular expression version.
Specifies whether the probe uses Transmission Control Protocol (TCP) or User Datagram Protocol (UDP).
Default: TCP
The Add New Discovery Verification Rule pane on the Blueprint wizard Discovery Verification Rules page contains the following Discovery Verification Rule fields:
Defines a name for the discovery verification rule.
Describes the blueprint item.
Defines which of the following directive types the product uses to:
The Directive Type drop-down list contains the following options:
Defines a fixed value that the product uses to substitute variables or to construct complex strings. This directive type has the following common uses:
Queries a database on a managed server, and (optionally) extracts a value from the data retrieved. This directive type has the following common uses:
Retrieves the contents of a specific file (when the file location is known). The product then filters the contents to define a directive value. This directive type has the following common uses:
Retrieves the value at a management information base (MIB) address from an SNMP agent, and (optionally) sets the directive value from the results.
Lists all files and directories at a designated location in a managed server file system, and (optionally) extracts the directive value from the list.
(Windows Only) Lists registry key and registry value names at a location in the registry tree, and (optionally) extracts the directive value from the list.
(Windows Only) Lists all registry key and registry value names at a location in the registry tree.
(Optional) Retrieves the data value of the selected names as the directive value.
Defines the parameters of a TCP socket opened to a remote service server and port. You can (optionally) send a probe to the port, and collect a response from the socket as the directive value.
(Windows only) Retrieves the data value that is associated with a registry key or value, and (optionally) defines the directive value from the filtered results.
Runs a command or script on a managed server. The product captures the command output and returns it as the directive value. The regular expression typically filters the value to extract a concise value from verbose command output. This directive type has the following common uses:
Retrieves the application configuration data that is exposed as web services. The directive queries the web services and parses the returned data to configuration variables. The directive supports the configuration executables that can retrieve and store the configuration data.
Provide the WSDL URL where the web service is running. Web Services Description Language (WSDL) is an XML-based language that provides a model for describing web services.
Default: Constant
Specifies when verification directives run during discovery, relative to when the component parameter directives run:
The verification directive requires a Component parameter value for the variable substitution. The Component parameter value is the parameter name that is defined in the Component Parameters and Variables tab. The Component parameter value ensures that the substituted variables have the values that are required for the verification.
The verification directive does not depend on the value of any Component parameters.
Default: Late
Defines a fixed string or a string that contains one or more variable substitutions.
You can define a constant value as blank (one or more spaces). The blank value appears as no value on the user interface, but the product considers it a valid value.
Examples:
$(VariableName)
C:\$(V)\$(V2)\file.xml
You can also use the following variable syntax:
Defines normal component variable substitution.
References a parameter in the parent component.
References a global variable.
Defines a regular expression that describes a set of strings. If you use the variable substitution to define a constant value, you can use a regular expression to filter the value. You can also use the regular expression like a conditional expression to test the value and return it in one of the following ways:
Defines which subexpression the product returns on match if a regular expression includes a parenthesized subexpression.
Default: 0 (if you specify no Paren value).
Defines the attribute that the product compares to the regular expression directive value. If the value does not match, the directive fails.
Defines the attribute to which the product compares the directive value. If the values are not equal, the directive fails.
Specifies whether the product considers text case for matches.
Default: Case Sensitive
Note: The default (Case Sensitive) option does not consider Agent_conf and agent_conf to be a match. The Case Insensitive option considers Agent_conf and agent_conf to be a match.
Defines a unique name that the translation applies to the directive output. The product precedes the specified Translate value with $CCTranslation$__ at run time so the value is identifiable in the database as a translation. If no translation matches, the product retains the original directive result.
The directive values that the product extracts from the configuration files and the registry is sometimes cryptic strings or integers that belong to an enumeration. Each value corresponds to a configuration state, but the value does not interpret the state. The product can translate these values to meaningful strings so they are clear when it displays them in the blueprint.
Map values in the product Database to refer to the translation name and trigger the translation of from values to to values. The following example maps the translation $CCTranslation$__IIS SERVER STATE:
<BlueprintTranslation name="IIS server state" coh_name="IIS_SERVER_STATE" coh_id="23501" created_by="system_user">
<BlueprintTranslationEntry translate_from="2" translate_to="Running" /> <BlueprintTranslationEntry translate_from="4" translate_to="Stopped" /> <BlueprintTranslationEntry translate_from="6" translate_to="Paused" />
</BlueprintTranslation>
The product does not associate translations with a specific blueprint. To avoid conflict with other translations, ensure that each translation has a unique name.
Note: The product user interface does not currently support defining translation tables. Create the files in CA Configuration Automation data load format (as the example shows), and then load them to the database with the data loader utility.
Defines the XSL transform with which to filter a returned XML-formatted directive value. The transformed value replaces the original returned value and can be either a new XML value or any other text that the transformation generates.
To run an XSL transform, specify the location of an XSL file to apply to the directive value. The transform location can be a URL (file, http, or other) that is visible from the server, or a file name in the server CLASSPATH. The product retrieves the transform and applies it to the directive value to produce a new value for the directive.
Defines the value of a directive that the product inserts in another string to produce the appropriate result for display or for a subsequent operation.
The insertion location can be any string that contains $(VALUE) (all uppercase letters). The directive value replaces $(VALUE) to produce the filtered result. For example, if the initial directive value is 3 and the insertion string is 1.$(VALUE).export, the filtered directive value is 1.3.export.
Modifies the discovery results. Select either the Does Host Use Agent or Is Alterpoint Device modifiers.
Defines the parameters that the product applies to the specified modifier.
The $(Root) pane on the Blueprint wizard Management page contains the following File Management Options fields:
Defines how many directory levels the discovery operation verifies below the file system root.
Specifies how many files the discovery operation retrieves.
Selected: The discovery operation retrieves up to 50,000 files.
Cleared: The discovery operation retrieves up to the number of files that the Maximum Files field specifies.
Defines the maximum number of files that the discovery operation retrieves.
The Add New Directory pane on the Blueprint wizard Management page contains the following Directory fields:
Defines a name for the element to add. You can use wildcard characters (*) to define the name with the POSIX pattern-matching syntax (for example, Agent_*).
Defines the partial path on which to locate the element. Define only the directories or folders between the file indicator and the component root (not the entire component path).
The Add New File pane on the Blueprint wizard Management page contains the following File fields:
Defines a name for the element to add. You can use wildcard characters (*) to define the name with the POSIX pattern-matching syntax (for example, Agent_*).
Defines the partial path on which to locate the element. Define only the directories or folders between the file indicator and the component root (not the entire component path).
The Rules tab on the Component Blueprint wizard File Filters and Attributes page contains the following fields:
Defines a name for the rule.
Describes the blueprint item.
Specifies a URL where the rule documentation is located.
Specifies either the File or Directory constraint type to which the rule applies.
Specifies the operation that the rule for the selected Constraint Type uses.
Specifies the value that is taken as the reference for the Operation. The constraint type, operation, and value define a match criteria for the rule.
Specifies whether the rule is enabled (selected) or disabled (cleared).
Defines the string that the product writes to the Rule Compliance results when a compliance operation that uses this blueprint fails the rule.
Specifies which error level determines that the rule failed.
The $(RegistryRoot) pane on the Blueprint wizard Management page contains the following Registry Management Options fields:
Defines how many directory levels the discovery operation verifies below the file system root.
Specifies how many elements the discovery operation retrieves.
Selected: The discovery operation retrieves up to 50,000 elements.
Cleared: The discovery operation retrieves up to the number of elements that the Maximum Elements field specifies.
Defines the maximum number of elements that the discovery operation retrieves.
The Component Blueprint wizard Registry Filters and Attributes page contains the following Add Key fields:
Defines the default registry key value.
Specifies which of the following entities the product interprets the key as:
Specifies whether the key is a relationship key.
Specifies one of the following relationship types:
Establishes the relationship between an application and a database server.
Establishes the relationship between a server that manages another server. For example, select Manages to view the relationship between a VMware vCenter Server that manages a VMware ESX host.
Establishes the relationship between a server that hosts another server. For example, select Hosts to view the relationship between a VMware ESX host that hosts a VMware virtual machine.
Establishes the relationship between servers.
Specifies whether the value is shown or hidden.
Defines the target server information that is available in any other component parameter. To define the parameter, use variable substitution.
Defines the target database instance or application instance that is available in any other component parameter. To define the parameter, use variable substitution.
Specifies the target application information available in any other parameters. Use variable substitution methods to define the parameter.
The Component Blueprint wizard Registry Filters and Attributes page contains the following Value Details fields:
Defines the default registry key value.
Specifies which of the following entities the product interprets the key as:
Specifies whether the key is a relationship key.
The Component Blueprint wizard Database page contains the following fields:
Defines a name for the database.
Describes the blueprint item.
Defines the database access description.
Defines the account name of a user that can access the database.
Defines the password that is associated with the specified user account.
Defines the server where the database is installed.
Defines the listening port of the database host server.
Specifies the type of database in use, from the following options:
Defines the environment variables that the agent sets before it runs the command.
The product runs the remote command in the CA Configuration Automation Agent environment. If the agent does not have the environment setup that is required to run a command, define the necessary environment variables as a comma-separated list of name/value pairs in the form name=value. For example:
<var_name>=<value>,<var_name2>=<value2>
The agent supports the variable substitution method.
The Component Blueprint wizard Component Parameters and Variables page contains the following fields:
Defines a parameter substitution expression in the following form:
$(VariableName)
Defines the name of a discovery parameter that is defined in the component. By default, the Name value is case-sensitive, so it must match the parameter name exactly.
If the Discovery parameters have the following values:
User=info Domain=ca.com v1=$(User) v2=$(Domain)
the following parameter substitution expression:
$(User)@$(Domain) [$(v1) at $(v2)]
returns the following results after evaluation:
info@ca.com [info at ca.com]
Describes the blueprint item.
Defines the item location.
Defines which of the following categories the product uses to organize the elements. When you double-click an item in the Available Categories column, it moves to the Selected Categories column.
Defines administrative settings relative to general component availability and management. Examples of administrative settings include:
Defines component configuration settings that are not related to the Administration, Log and Debug, Network, or Performance settings. Examples of configuration settings include a component alias or default web page.
Defines the elements that document the component behavior or provide information to users. For example, guides, readme files, FAQs, or online help pages.
Defines the elements that let the user set log locations, log levels, debug output, or diagnostic variable types.
Defines the elements that represent a network-related component setting (for example, the SNMP port settings). If an element can be categorized as both Network and Security (for example, enabling LDAP Authentication), set the category to Security.
CA internal use only.
Defines the performance settings, which are generally a specific subset of configuration parameters. For example, number of threads or number of concurrent users.
Defines general (static) product information (for example, licensing, installation location, vendor, or module name).
Defines component resources (for example, storage, memory and cache allocation or size, or CPU).
Note: The static Resource category is different from the Transient category, which defines real-time information.
Defines the elements that represent security-related settings, which are generally a specific subset of configuration parameters. For example, authentication types, enabling authentication, encryption settings, directory browsing, SSL, or HTTPS.
Defines the elements that regularly change. For example, server states (up, down, running, or stopped), current number of connected clients, current number of threads, or current disk utilization.
Defines the elements that indicate the product version or patch levels.
Defines which of the following elements the product filters from the Compare operations. When you double-click an item in the Available Filters column, it moves to the Selected Filters column.
Filters the elements that are specific to a single component instance (for example, installation root and Service Server Name). Excludes component-specific elements that are already known to be different from Change Detection operations and results.
Filters the elements that are specific to a service (for example, server names and installation roots). Excludes service-specific elements that are already known to be different from Change Detection operations and results.
Filters the elements that are specific to a single server (for example, the Server name and IP address). Excludes server-specific elements that are already known to be different from Change Detection operations and results.
Identifies the elements to exclude permanently from Change Detection operations and results. Examples include temporary directories, log files in the managed folder, or elements that are known to be transient.
Identifies the elements to exclude permanently from Rule Compliance operations and results because they are inconsequential or variable. Examples include temporary directories, known old configuration files, templates, or example files.
Filters the elements that are known to change over time, but not necessarily across servers or across services. Examples include log files, process start times, and registry event counters. Excludes time-variant parameters that are already known to be different from Change Detection operations and results.
Specifies the relative importance of an element:
Default: Medium (elements for which you assign no weight)
Defines which of the following directive types the product uses to:
The Directive Type drop-down list contains the following options:
Defines a fixed value that the product uses to substitute variables or to construct complex strings. This directive type has the following common uses:
Retrieves the value of a configuration parameter from a parsed configuration file or from a configuration program file.
Queries a database on a managed server, and (optionally) extracts a value from the data retrieved. This directive type has the following common uses:
Retrieves the contents of a specific file (when the file location is known). The product then filters the contents to define a directive value. This directive type has the following common uses:
Retrieves named data sets from a Directory Server, and (optionally) extracts the directive value from the output.
Retrieves the value at a management information base (MIB) address from an SNMP agent, and (optionally) sets the directive value from the results.
Lists all files and directories at a designated location in a managed server file system, and (optionally) extracts the directive value from the list.
(Windows Only) Lists registry key and registry value names at a location in the registry tree, and (optionally) extracts the directive value from the list.
(Windows Only) Lists all registry key and registry value names at a location in the registry tree. You can (optionally) set the directive value from the data value of the selected names.
Defines the parameters of a TCP socket opened to a remote service server and port. You can (optionally) send a probe to the port, and collect a response from the socket as the directive value.
(Windows only) Retrieves the data value that is associated with a registry key or value, and (optionally) defines the directive value from the filtered results.
Runs a command or script on a managed server. The product captures the command output and returns it as the directive value. The regular expression typically filters the value to extract a concise value from verbose command output. This directive type has the following common uses:
Run utilities and scripts to update a managed server.
Defines a fixed string or a string that contains one or more variable substitutions. If the directive runs and the product cannot determine a value, the product uses the default value instead of an undefined or zero-length value.
Specifies whether a parameter persists in a service.
The product saves the parameter and displays it in the service tree view.
The product does not save the parameter only uses it for discovery.
The product saves the parameter and (if the parameter has a value) displays it in the service tree view.
Default: Always Persist
Specifies whether the product shows the element and the element value.
Displays the element value.
Displays ******* instead of the element value. Hide the parameter if:
The product encrypts the hidden parameters in the database. They are not displayed or viewable in the UI.
Note: To ensure the security of this field, reenter the value if you later decide to show it.
Hides the parameter. Select Hide Element so the value is available for variable substitution, but is not displayed in the service tree view.
Default: Show Value
Specifies whether the product considers text case for matches.
Default: Case Sensitive
Note: The default (Case Sensitive) option does not consider Agent_conf and agent_conf to be a match. The Case Insensitive option considers Agent_conf and agent_conf to be a match.
Defines a hint about the string format of a configuration parameter and how the associated component uses it. The product uses context-sensitive parsers to inspect interpreted parameter values. The parsers let the product extract multiple subvalues from complex parameter strings.
Default: blank (no interpretation)
Specifies whether the product determines and assigns relationships according to the Interpret As value.
To establish relationships, set the Interpret As value and then set the Relationship Key field to Yes. Not all interpretations can define relationships.
Default: No
Specifies one of the following relationship types:
Establishes the relationship between an application and a database server.
Establishes the relationship between a server that manages another server. For example, select Manages to view the relationship between a VMware vCenter Server that manages a VMware ESX host.
Establishes the relationship between a server that hosts another server. For example, select Hosts to view the relationship between a VMware ESX host that hosts a VMware virtual machine.
Establishes the relationship between servers.
Defines the target server information that is available in any other component parameter. To define the parameter, use variable substitution.
Defines the target database instance or application instance that is available in any other component parameter. To define the parameter, use variable substitution.
Specifies the target application information available in any other parameters. Use variable substitution methods to define the parameter.
Defines a unique name that the translation applies to the directive output. The product precedes the specified Translate value with $CCTranslation$__ at run time so the value is identifiable in the database as a translation. If no translation matches, the product retains the original directive result.
The directive values that the product extracts from the configuration files and the registry is sometimes cryptic strings or integers that belong to an enumeration. Each value corresponds to a configuration state, but the value does not interpret the state. The product can translate these values to meaningful strings so they are clear when it displays them in the blueprint.
Map values in the product Database to refer to the translation name and trigger the translation of from values to to values. The following example maps the translation $CCTranslation$__IIS SERVER STATE:
<BlueprintTranslation name="IIS server state" coh_name="IIS_SERVER_STATE" coh_id="23501" created_by="system_user">
<BlueprintTranslationEntry translate_from="2" translate_to="Running" /> <BlueprintTranslationEntry translate_from="4" translate_to="Stopped" /> <BlueprintTranslationEntry translate_from="6" translate_to="Paused" />
</BlueprintTranslation>
The product does not associate translations with a specific blueprint. To avoid conflict with other translations, ensure that each translation has a unique name.
Note: The product user interface does not currently support defining translation tables. Create the files in CA Configuration Automation data load format (as the example shows), and then load them to the database with the data loader utility.
Defines the XSL transform with which to filter a returned XML-formatted directive value. The transformed value replaces the original returned value and can be either a new XML value or any other text that the transformation generates.
To run an XSL transform, specify the location of an XSL file to apply to the directive value. The transform location can be a URL (file, http, or other) that is visible from the server, or a file name in the server CLASSPATH. The product retrieves the transform and applies it to the directive value to produce a new value for the directive.
Defines the value of a directive that the product inserts in another string to produce the appropriate result for display or for a subsequent operation.
The insertion location can be any string that contains $(VALUE) (all uppercase letters). The directive value replaces $(VALUE) to produce the filtered result. For example, if the initial directive value is 3 and the insertion string is 1.$(VALUE).export, the filtered directive value is 1.3.export.
Modifies the discovery results. Select either the Does Host Use Agent or Is Alterpoint Device modifiers.
Defines the parameters that the product applies to the specified modifier.
The Configuration - File Parsing page contains the following fields:
Defines the name of the configuration file that the product locates and parses during discovery. You can use wildcard characters (for example, ^ or $) to define the name as per regex naming conventions.
Defines the name of the configuration file that the product displays after discovery.
Describes the blueprint item.
Specifies the type of configuration file (for example, text, binary, or log)
The Configuration Executables page contains the following fields:
Defines a name for the configuration executable. This name appears under Executables in the Configuration folder. The name must be unique in the Executables folder.
(Optional) Describes the blueprint item. The product displays the description as a tool-tip over the directive name in the blueprint and over the parameter name in the tree views.
Specifies the type of directive the product uses to obtain the parameter value. All directives return a value and a Boolean result. The value appears next to the parameter name when the discovered parameter appears in the service tree view.
Note: The Configuration directive type extracts a value from a managed configuration file.
Default: Constant
Defines the name of a configuration file that is in either the Configuration, Files folder or the Configuration, Executables folder. You can specify a specific file name or a regular expression. If you specify a regular expression, the product selects all matching files in the Configuration folder. If multiple files match, the product selects the file closest to the root of the managed file system. The product allows variable substitution.
Defines the path to the configuration file. The product does not support wildcard characters or pattern matching, but it allows variable substitution. The path can either be absolute (for example, $(Root)/conf) or relative (for example, /conf) to the root of the managed file system. If the configuration file is at the configuration file system root, you can define Path as $(Root) or you can leave it undefined.
Defines the name of the configuration parameter in the file. The product does not support wildcard characters or pattern matching, but it allows variable substitution. You can leave the Parameter attribute undefined if the value belongs to a Group file block. In that case, specify only the Group Path attribute.
Specifies whether to filter the named value with a regular expression if the product finds it.
Defines which subexpression the product returns on match if a regular expression includes a parenthesized subexpression.
Default: 0 (if you specify no Paren value).
Specifies hierarchically organized configuration files. Use the Group Path value within the file to the name Parameter and that is specified like a partial file system path (for example, a/b/c).
Because a single file often contains the same name many times, use a unique Group Path to differentiate a specific value from the matching names. For example, an XML configuration file can have the following format, where the tag server and the buildDate and type attributes occur many times:
<configuration>
<server name= “wxp123”> <setup buildDate=”10/30/2003” type=”webserver”/> </server> <server name=”wxp123” auxiliary=”true”> <setup buildDate=”09/02/2002” type=”webserver”/> </server> <server name=”wxp124”> <setup buildDate=”10/29/2003” type=”dataserver”/> </server>
</configuration>
To identify children that must match for the product to follow the path, use a comma-separated list of Group Path names (or names and values). For example, to extract the buildDate value for server wxp124, define the following values:
buildDate
configuration/server,name=wxp124/setup
Extracting the buildDate value from the server wxp123 auxiliary data only requires the name because it is the only server tag with an auxiliary attribute:
buildDate
configuration/server,auxiliary/setup
You can qualify any or all of the elements in a Group Path and you can specify multiple qualifiers for each element. If you specify multiple qualifiers, each qualifier must match to select a path. The product allows variable substitution.
If a structure class for the configuration file defines group blocks qualifiers, the product allows an alternate syntax. For group blocks, you can surround the qualifier value with parentheses and append it to the block name. For example, to extract the value of buildDate from server wxp124 where the attribute name is a Qualifier Child, specify the following values:
buildDate
configuration/server(wxp124)/setup
The value in parentheses matches the qualifier of the named group block. Either a Qualifier Child value or a constant Qualifier in the structure class defines the qualifier, or the qualifier is the group value.
If you are not sure about the parameter location in the file, you can specify multiple paths. Separate two or more specified paths with a pipe ( | ). The product tries the paths one at a time, from left to right, until a match it finds a match. For example:
buildDate
configuration/server(abc)/setup|configuration/server(xyz)/setup
Specifies whether to override the default product behavior when the named configuration parameter in the file has no value. The default behavior is to set the value to an empty, zero-length value. The Empty Is Null field lets you distinguish between a directive that returns an empty value and a directive that returns no value.
Uses the value in the Default field.
Does not use the value in the Default field.
Default: No
Defines a fixed string or a string that contains one or more variable substitutions. If the product cannot determine a value when it runs the directive, the product uses this value instead of an undefined or zero-length value.
In some cases (for example, if a Component Blueprint plug-in can set a directive), you do not want the Default value to replace the directive. To keep the Default value from replacing the plug-in value, set it to Cohesion.PLACEHOLDER.
Specifies whether the product considers text case for matches.
Default: Case Sensitive
Note: The default (Case Sensitive) option does not consider Agent_conf and agent_conf to be a match. The Case Insensitive option considers Agent_conf and agent_conf to be a match.
Defines a unique name that the translation applies to the directive output. The product precedes the specified Translate value with $CCTranslation$__ at run time so the value is identifiable in the database as a translation. If no translation matches, the product retains the original directive result.
The directive values that the product extracts from the configuration files and the registry is sometimes cryptic strings or integers that belong to an enumeration. Each value corresponds to a configuration state, but the value does not interpret the state. The product can translate these values to meaningful strings so they are clear when it displays them in the blueprint.
Map values in the product Database to refer to the translation name and trigger the translation of from values to to values. The following example maps the translation $CCTranslation$__IIS SERVER STATE:
<BlueprintTranslation name="IIS server state" coh_name="IIS_SERVER_STATE" coh_id="23501" created_by="system_user">
<BlueprintTranslationEntry translate_from="2" translate_to="Running" /> <BlueprintTranslationEntry translate_from="4" translate_to="Stopped" /> <BlueprintTranslationEntry translate_from="6" translate_to="Paused" />
</BlueprintTranslation>
The product does not associate translations with a specific blueprint. To avoid conflict with other translations, ensure that each translation has a unique name.
Note: The product user interface does not currently support defining translation tables. Create the files in CA Configuration Automation data load format (as the example shows), and then load them to the database with the data loader utility.
Defines the XSL transform with which to filter a returned XML-formatted directive value. The transformed value replaces the original returned value and can be either a new XML value or any other text that the transformation generates.
To run an XSL transform, specify the location of an XSL file to apply to the directive value. The transform location can be a URL (file, http, or other) that is visible from the server, or a file name in the server CLASSPATH. The product retrieves the transform and applies it to the directive value to produce a new value for the directive.
Defines the value of a directive that the product inserts in another string to produce the appropriate result for display or for a subsequent operation.
The insertion location can be any string that contains $(VALUE) (all uppercase letters). The directive value replaces $(VALUE) to produce the filtered result. For example, if the initial directive value is 3 and the insertion string is 1.$(VALUE).export, the filtered directive value is 1.3.export.
Modifies the discovery results. Select either the Does Host Use Agent or Is Alterpoint Device modifiers.
Defines the parameters that the product applies to the specified modifier.
Specifies either Structure Class or Parser. Select an option from the corresponding drop-down list.
The Component Blueprint wizard Add Query pane contains the following fields:
Defines which directive queries a database on a managed server, and (optionally) extracts a value from the output data. This directive is commonly used to:
The specified name must be unique in the executables folder of a blueprint.
(Optional) Describes the blueprint item. The product displays the description as a tool-tip over the directive name in the blueprint and over the parameter name in the tree views.
Specifies one of the following query types that direct the product how to run the query and whether the query returns data:
The query is an SQL select statement that returns data.
The query is an SQL insert statement that returns no data.
The query is an SQL delete statement that returns no data.
The query is an SQL update statement that returns no data.
The query is an SQL alter table or other DDL statement that returns no data.
The query string invokes a stored procedure that can return data.
Defines an SQL query or stored procedure name. Query syntax can vary depending on the database type, and variable substitution is allowed. The product returns all rows that the query or stored procedure finds. To filter the result set, use the column and regular expression attributes.
Defines the maximum number of rows that a query returns.
Default: 5000
Defines the name of the column or an aliased column in the returned result set. The product takes the value in the named column as the directive value. If the query returns more than one row, the product uses the named column in the first row.
Defines the hierarchical collection of groups and parameters that the product uses to map metadata to the name/value pairs that the parser retrieves.
Defines a note about the selected element. The product shows the number of notes on the element or None in brackets. From the drop-down list, you can view all notes, add a note, or view, update, or delete a note.
Defines a name for the note.
Defines the note text.
If you select an existing note, the Notes field shows the note name with the note text below the name. You can update, delete, or cancel the selected note.
The File Structure Class tab contains the following fields:
Defines a name for the structure class. The Blueprint list and (unless you specify a Display Name) the tree view show the specified structure class name.
Defines the structure class version of the structure class. The Blueprint list and (unless you specify a Display Name) the tree view show the specified version.
Defines the class name that the Component Tree view shows if it differs from the Name and Version fields. For example, you can specify a Display Name value that is more descriptive of the class function.
(Optional) Describes the blueprint item. The product displays this description as a tool-tip over the class name in the Blueprint tree view.
Specifies whether the product can modify the changeable blueprint elements as specified in a remediation job.
Default: Yes
Defines the parser to use for files of the defined type. The product includes a library of predefined lexical analyzers (lexers) and parsers that let the product analyze most common configuration file formats.
The Add Group and Add Parameter panes on the Precedence tab contain the following fields:
Defines name for the precedence group.
Describes the blueprint item.
Specifies a category for the group. Double-click one or more categories to move them to the Selected Categories column.
Specifies a filter for the group. Double-click one or more filters to move them to the Selected Filters column.
Specifies the relative importance of an element:
Default: Medium (elements for which you assign no weight)
Specifies the elements data type (for example, string, Boolean, or integer).
Defines the valid parameter or group values for a data type range (for example, integer enumeration, integer range, or string enumeration).
Defines a fixed string or a string that contains one or more variable substitutions. If it cannot determine a value at run time, the product uses the Default Value instead of an undefined or zero-length value.
If a Component Blueprint plug-in can set the directive value, you can set Default Value to Cohesion.PLACEHOLDER to keep the specified Default Value from replacing the plug-in value.
Specifies whether the product shows the element and the element value.
Displays the element value.
Displays ******* instead of the element value. Hide the parameter if:
The product encrypts the hidden parameters in the database. They are not displayed or viewable in the UI.
Note: To ensure the security of this field, reenter the value if you later decide to show it.
Hides the parameter. Select Hide Element so the value is available for variable substitution, but is not displayed in the service tree view.
Default: Show Value
Specifies whether the product considers text case for matches.
Default: Case Sensitive
Note: The default (Case Sensitive) option does not consider Agent_conf and agent_conf to be a match. The Case Insensitive option considers Agent_conf and agent_conf to be a match.
Defines a hint about the string format of a configuration parameter and how the associated component uses it. The product uses context-sensitive parsers to inspect interpreted parameter values. The parsers let the product extract multiple subvalues from complex parameter strings.
Default: blank (no interpretation)
Specifies whether the product determines and assigns relationships according to the Interpret As value.
To establish relationships, set the Interpret As value and then set the Relationship Key field to Yes. Not all interpretations can define relationships.
Default: No
Specifies one of the following relationship types:
Establishes the relationship between an application and a database server.
Establishes the relationship between a server that manages another server. For example, select Manages to view the relationship between a VMware vCenter Server that manages a VMware ESX host.
Establishes the relationship between a server that hosts another server. For example, select Hosts to view the relationship between a VMware ESX host that hosts a VMware virtual machine.
Establishes the relationship between servers.
Defines the target server information that is available in any other component parameter. To define the parameter, use variable substitution.
Defines the source database instance or application instance.
Defines the target database instance or application instance that is available in any other component parameter. To define the parameter, use variable substitution.
Specifies the target application information available in any other parameters. Use variable substitution methods to define the parameter.
Defines the expected value of the parameter or group.
Defines a unique value for the group in the file.
Defines the parameter that the product uses as a qualifier under the group.
The Macros page contains in the following fields:
Defines a name for the macro.
Describes the blueprint item.
Defines the item location.
Specifies whether the product uses the macro to diagnose issues.
Default: No
Specifies whether the macro can modify the target system.
Note: To run a read-only macro, the user must have Server View or Service View permissions.
Default: No (the macro cannot modify the target system).
The wizard page contains the following fields:
Specifies whether the blueprint can contain other components.
Specifies whether other components can contain the blueprint.
Note: By default, the Allow this blueprint to contain other components, and Allow this blueprint to nest in other components checkboxes are enabled.
Specifies whether the blueprint can contain only named components.
Specifies whether the blueprint can use nesting.
Specifies the position that this component refreshes relative to all others on a specific server. The product refreshes components on each server sequentially and refreshes components on other servers in parallel.
Refresh order is important when components depend on each other for variable substitution. For example, if one component uses a parameter value from another component for the variable substitution, the product must refresh the other component first. If you do not specify Refresh Order in this case, the dependent component can pick up a value that the current refresh has not updated.
Refresh Order has the following values. No specific order is guaranteed within a level. :
Specifies one of the following options: to modify the discovered results:
Defines the parameters for the selected Modifier.
Specifies whether the product selects the component with the closest file system root (in terms of depth) if a component can nest in multiple components.
Default: Yes
Specifies the file system relationship that determines whether the component nests in other components.
Note: If you select This Blueprint Will Not Use Nesting, Nest By is not required:
Defines that the component should nest in any component whose file system root is higher in the file system directory tree.
Defines that the component should nest in any component whose file system root is equal to or higher in the file system directory tree.
Defines that the component can nest only in components whose file system root is one level higher in the file system directory tree.
Defines that the component should nest in any component with the same file system root.
Defines the blueprint that uses the nesting defined on this page. Double-click a blueprint in the Available Component Blueprints column to move it to the Selected Component Blueprints column.
Specifies the component only nests in another component whose file system root is located above it, with the exact relative path between them. Use this option to select a specific nesting match or to restrict nesting to an exact location in the file system directory tree.
Specifies the component only nests in another component whose file system root is located above it, with the exact depth between them. Use this option to select a specific nesting match or to restrict nesting to an exact depth in the file system directory tree.
|
Copyright © 2013 CA.
All rights reserved.
|
|