Adapter request for version 2.6 addElements operation for BMC Performance Manager Portal
The version 2.6 addElements operation is compatible with BMC Performance Manager Portal 2.5 and later, and adds one or more infrastructure elements to the Portal.
- When adding a single element, you must provide the following properties:
- host name or IP address of the element
- existing profile name to apply to the element
- existing RSM or RSM cluster to monitor the element
- operating system of the element
- existing object group to which to assign to the element
You can also provide the element name. If you do not provide the element name, the operation uses the host name or IP address for the element name.
To add multiple elements, you must first list each element's properties in a comma-separated value (CSV) file that uses the following format, which is also illustrated in the following figure:
hostName or ipAddress, [conbaobpm: elementDisplayName ], objectGroupName, rsmName, elementProfileName, platformName
Sample CSV file for adding multiple infrastructure elements to version 2.6 Portal
computer1.acme.com,"My Computer","Windows Servers","Acme RSM","Windows Settings",""
computer2.acme.com,Acme1,"UNIX Servers","Acme RSM","UNIX Settings","AIX"
111.222.3.4444,,"Windows Servers","Acme RSM","Windows Settings","Linux"
The following table describes the elements for this request. The required elements for the request vary depending on whether you add a single infrastructure element or multiple infrastructure elements to the BMC Performance Manager Portal. To override the configuration properties in the Adapter configuration, include the target port, user-name, and password elements in the request. For more information about these elements, see Node elements required to configure the actor adapter.
The [confluence_table-plus] macro is a standalone macro and it cannot be used inline.1 If you do not provide a value for element-name, the bpmcli assigns the value in element-host-name to the display name of the infrastructure element.
2 If you do not specify a value for this element, you must provide a CSV file that contains this value.
Assuming that the CSV file contains all of the properties for an element, the sample Adapter request in the following figure contains the minimum requirements for adding multiple infrastructure elements.
Sample Adapter request for version 2.6 addElements operation
<bmc-performance-manager-portal-request>
<commands>
<command>
<name>addElements</name>
<arguments>
<target>dev2</target>
<port>443</port>
<user-name>user</user-name>
<password>user</password>
<return-messages>true</return-messages>
<secure>true</secure>
<element-host-name>dbserver1</element-host-name>
<element-name>Dataserver1</element-name>
<profile-name></profile-name>
<rsm-name></rsm-name>
<object-group></object-group>
<csv-file-name>myNewElements.txt</csv-file-name>
<version>v2.6</version>
<platform>Windows</platform>
</arguments>
</command>
</commands>
</bmc-performance-manager-portal-request>
If the return-messages element is set to true, the addElements operation returns the following message for each new element:
SUCCESS, msg [conbaobpm:added element], user [conbaobpm: UserName ], element [conbaobpm: ElementName ], group [conbaobpm: GroupName ], platform [conbaobpm: PlatformName ], rsm [conbaobpm: RsmName ], host [conbaobpm: HostName ], profile [conbaobpm: ProfileName ]