HP SIM Protocol

Search for	Example	Results
A single word	`cat`	Topics that contain the word "cat". You will also find its grammatical variations, such as "cats".
A phrase. You can specify that the search results contain a specific phrase.	`"cat food"` (quotation marks)	Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase.

Search for	Operator	Example
Two or more words in the same topic	`AND` `and` `+` (plus symbol) `&` (ampersand)	`cat AND dog` `"cat food"+milk` `"cat food"&"dog food"`
Either word in a topic	`OR` `or` `\|` (pipe)	`cat OR dog` `cat \| dog`
Topics that do not contain a specific word or phrase	`NOT` `not` `!` (exclamation point)	`NOT cat` `! dog`
Topics that contain one string and do not contain another	`^` (caret)	`cat ^ mouse`
A combination of search types	`( )` parentheses	`cat + (dog \| mouse)` `cat \| dog + (! mouse)`

Parameter	Description
Port Number	The port at which the SIM MXPartner WebService API listens for SOAP requests. The defaults are 280 for HTTP and 50001 for HTTPS.
SIM Database Instance	Microsoft SQL Server: Enter the instance name only for non-default instances of Microsoft SQL Server. Oracle: Enter the SID.
SIM Database Username	The database user (Microsoft SQL Server) or schema name (Oracle) with permissions to access the database.
SIM Database Name	(Microsoft SQL Server only) Enter the name of the database.
SIM Database Password	The password of the database user (Microsoft SQL Server) or schema name (Oracle) for the SIM database.
SIM Database Port	The listener port for the database.
SIM Database Type	The SIM Database type: MSSQL MSSQL_NTLM MSSQL_NTLMv2 Oracle
SIM Webservice Protocol	Choose between HTTP or HTTPS.
Username	The name of the user needed to connect to the application.
Password	The password of the user needed to connect to the application.

Parameter

Description

Port Number

The port at which the SIM MXPartner WebService API listens for SOAP requests. The defaults are 280 for HTTP and 50001 for HTTPS.

SIM Database Instance

Microsoft SQL Server: Enter the instance name only for non-default instances of Microsoft SQL Server.
Oracle: Enter the SID.

SIM Database Username

The database user (Microsoft SQL Server) or schema name (Oracle) with permissions to access the database.

SIM Database Name

(Microsoft SQL Server only) Enter the name of the database.

SIM Database Password

The password of the database user (Microsoft SQL Server) or schema name (Oracle) for the SIM database.

SIM Database Port

The listener port for the database.

SIM Database Type

The SIM Database type:

MSSQL
MSSQL_NTLM
MSSQL_NTLMv2
Oracle

SIM Webservice Protocol

Choose between HTTP or HTTPS.

Username

The name of the user needed to connect to the application.

Password

The password of the user needed to connect to the application.

Note When the CyberArk integration is enabled, two radio buttons (Regular Credential and External Vault) are enabled. The existing Username and Password parameters are grouped under the Regular Credential radio button, and CyberArk integration specific parameters Type and Reference are enabled and grouped under the External Vault radio button, as described in the table below.

CyberArk-related Parameters
Parameter	Description
Regular Credential	Enabled when CyberArk integration is enabled. Select this radio button to use regular credential as before. Username. See description above. Password. See description above.
External Vault	Enabled when CyberArk integration is enabled. Select this radio button to use an external credential vault. Type. The external vault type. Currently only CyberArk is supported. Reference. Click to open the Configure dialog box. Reference. Select this option to configure the Reference ID that will be used by UCMDB/UD to retrieve the passwords from the CyberArk Enterprise Password Vault when they are needed. Set the reference ID in the CyberArk Enterprise Password Vault in the following format: <Safe Name>\<Folder Path>\<Reference ID>. Where <Safe Name> is the Safe value in CyberArk, <Folder Path> is the folder where the Safe belongs to, and <Reference ID> is the name of the CyberArk account you specified or auto-generated in CyberArk. For example, NancySafe\Root\nancy-cyberark-testing-refid. Parameter. Select this option to enable configuring a list of editable CyberArk properties as a query string for UCMDB/UD to retrieve passwords from the CyberArk Enterprise Password Vault. To configure a CyberArk property value, click in the Value column for the property, and specify the value in string. The CyberArk properties values must not contain any of the following characters: *\/:?"<>\|'.; The out-of-the-box list of CyberArk properties displayed in the Configure dialog box is editable. You can set selected CyberArk properties as the default list using JMX method setGlobalSettingVaule. For instructions, see "How to Set a Default List of CyberArk Properties Using JMX" in the HPE Universal CMDB Data Flow Management Guide. Regex. Enables configuring CyberArk properties values in regular expressions. For examples of how to use regular expression syntax, see "Regular Expression Examples" in the HPE Universal CMDB Modeling Guide. The CyberArk properties values in regular expression must not contain any of the following characters: : ;**

CyberArk-related Parameters

Parameter

Description

Regular Credential

Enabled when CyberArk integration is enabled. Select this radio button to use regular credential as before.

Username. See description above.
Password. See description above.

External Vault

Enabled when CyberArk integration is enabled. Select this radio button to use an external credential vault.

Type. The external vault type. Currently only CyberArk is supported.
Reference. Click to open the Configure dialog box.
- Reference. Select this option to configure the Reference ID that will be used by UCMDB/UD to retrieve the passwords from the CyberArk Enterprise Password Vault when they are needed.
  
  Set the reference ID in the CyberArk Enterprise Password Vault in the following format: <Safe Name>\<Folder Path>\<Reference ID>.
  
  Where <Safe Name> is the Safe value in CyberArk, <Folder Path> is the folder where the Safe belongs to, and <Reference ID> is the name of the CyberArk account you specified or auto-generated in CyberArk.
  
  For example, NancySafe\Root\nancy-cyberark-testing-refid.
- Parameter. Select this option to enable configuring a list of editable CyberArk properties as a query string for UCMDB/UD to retrieve passwords from the CyberArk Enterprise Password Vault.
  
  To configure a CyberArk property value, click in the Value column for the property, and specify the value in string.
  
  The CyberArk properties values must not contain any of the following characters: \/:*?"<>|'.;
  
  The out-of-the-box list of CyberArk properties displayed in the Configure dialog box is editable. You can set selected CyberArk properties as the default list using JMX method setGlobalSettingVaule. For instructions, see "How to Set a Default List of CyberArk Properties Using JMX" in the HPE Universal CMDB Data Flow Management Guide.
  - Regex. Enables configuring CyberArk properties values in regular expressions.
    
    For examples of how to use regular expression syntax, see "Regular Expression Examples" in the HPE Universal CMDB Modeling Guide.
    
    The CyberArk properties values in regular expression must not contain any of the following characters: : ;