Scripted SSH Connector

To authenticate with a login and password, set the authenticationType to PASSWORD in the connector configuration file, and set a user and password. For example:

"configurationProperties" : {
    ...
    "authenticationType" : "PASSWORD",
    "user" : "<USERNAME>",
    "password" : "<PASSWORD>",
    ...

To authenticate with a secure certificate, generate a pair of public/private keys. Install the public key on the server side and the private key on the OpenIDM host (where the connector is located). Set the authenticationType to PUBKEY in the connector configuration file and set the user, password, passphrase and privateKey properties. For example:

"configurationProperties" : {
    ...
    "authenticationType" : "PUBKEY",
    "user" : "<USERNAME>",
    "password" : "<PASSWORD>",
    "passphrase" : "secret",
    "privateKey" : ["-----BEGIN DSA PRIVATE KEY-----",
              "MIIBugIBAAKBgQDcB0ztVMCFptpJhqlLNZSdN/5cDL3S7aOVy52Ae7vwwCqQPCQr",
              "6NyUk+wtkDr07NlYd3sg7a9hbsEnlYChsuX+/WUIvbOKdMfeqcQ+jKK26YdkTCGj",
              "g86dBj9JYhobSHDoQ9ov31pYN/cfW5BAZwkm9TdpEjHPvMIaOxx7GPGKWwIVALbD",
              "CEuf1yJk9UB7v0dmJS7bKkbxAoGARcbAuDP4rB6MsgAAkVwf+1sHXEiGPShYWrVV",
              "qBgCZ/S45ELqUuiaN/1N/nip/Cc/0SBPKqwl7o50CUg9GH9kTAjmXiwmbkwvtUv+",
              "Xjn5vCHS0w18yc3rGwyr2wj+D9KtDLFJ8+T5HmsbPoDQ3mIZ9xPmRQuRFfVMd9wr",
              "DY0Rs7cCgYAxjGjWDSKThowsvOUCiE0ySz6tWggHH3LTrS4Mfh2t0tnbUfrXq2cw",
              "3CN+T6brgnpYbyX5XI17p859C+cw90MD8N6vvBxaN8QMDRFk+hHNUeSy8gXeem9x",
              "O0vdIxCgKvA4dh5nSVb5VGKENEGNEHRlYxEPzbqlPa/C/ZvzIvdKXQIUQMoidPFC",
              "n9z+mE2dAADnPf2m9vk=",
              "-----END DSA PRIVATE KEY-----"
             ],
    ...

Specify the hostname or IP address of the SSH server.

Set the port on which the SSH server listens.

The username of the account that connects to the SSH server.

The password of the account that is used to connect to the SSH server.

A string representing the remote SSH session prompt. This must be the exact prompt string, in the format username@target:, for example admin@myserver:~$. Include any trailing spaces.

A string that shows the full path to the sudo command, for example /usr/bin/sudo.

If set to true (the default), the input command echo is disabled. If set to false, every character that is sent to the server is sent back to the client in the expect() call.

Sets the terminal type to use for the session. The list of supported types is determined by your Linux/UNIX system. For more information, see the terminfo manual page ($ man terminfo).

If set to true, indicates that the default environment locale should be changed to the value of the locale property.

Sets the locale for the LC_ALL, LANG and LANGUAGE environment variables, if setLocale is set to true.

Specifies the connection timeout to the remote server, in milliseconds.

Specifies the timeout used by the expect() calls in scripts, in milliseconds.

Sets the authentication type, either PASSWORD or PUBKEY. For more information, see "Configuring Authentication to the SSH Server".

If true, the connector throws an exception when the expectTimeout is reached for an operation. Otherwise, the operation fails silently.

The path to the Groovy scripts that will perform the OpenICF operations, relative to your OpenIDM installation directory. The sample connector configuration expects the scripts in project-dir/tools, so this parameter is set to &{launcher.project.location}/tools in the sample configuration.

The directory in which the compiler should look for compiled classes. The default classpath, if not is specified, is install-dir/lib.

By default, scripts are loaded and compiled when a connector instance is created and initialized. Setting reloadScriptOnExecution to true makes the connector load and compile the script every time it is called. Do not set this property to true in a production environment, because it will have a significant impact on performance.

The name of the Groovy script that is used for each OpenICF operation.

Provides simple authentication with two parameters, presumed to be a user name and password.

Creates an object and its uid.

Deletes an object, referenced by its uid.

Resolves an object by its username and returns the uid of the object.

Describes the object types, operations, and options that the connector supports.

Enables an application to run a script in the context of the connector. Any script that runs on the connector has the following characteristics:

Runs a script on the target resource that is managed by this connector.

Searches the target resource for all objects that match the specified object class and filter.

Polls the target resource for synchronization events, that is, native changes to objects on the target resource.

Tests the connector configuration. Testing a configuration checks all elements of the environment that are referred to by the configuration are available. For example, the connector might make a physical connection to a host that is specified in the configuration to verify that it exists and that the credentials that are specified in the configuration are valid.

Updates (modifies or replaces) objects on a target resource.