Skip to Content
Information
Unsupported content This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Component - getComponentKeyByTemplateKeyAndServerId

Component - getComponentKeyByTemplateKeyAndServerId

Description :

This command provides a convenient method for getting a component handle based on a component template, server, and index of the component on that server.

Usually, only one component based on a specific template exists on a particular server. In this case, the index of that component is 0. This command is most useful when you know that there is only one component on the server.

If there is more then one component based on the same template on the same server, use a command such as getAllComponentKeysByTemplateKeyAndServerId to get a component handle.

Return type : DBKey

Command Input :

Variable Name

Variable Type

Description

templateKey

DBKey

The handle of the template used as a basis for the component you want.

deviceId

Integer

The ID of the server where you want to get a component handle.

index

Integer

The index (typically 0) of component for which you want a handle.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

BMC Server Automation Command Line Interface 8.5