ICISSHKeyInfo Interface

Use the ICISSHKeyInfo interface to retrieve information about EFT’s SSH public keys. The interface provides the set of read-only properties. (Refer also to the ICIServer:AvailableSSHKeys property.)

interface ICISSHKeyInfo : IDispatch{

Members

  • Property Fingerprint As String read-only

    • Retrieves the fingerprint of the SSH key.

    HRESULT Fingerprint([out, retval] BSTR* pVal);

    EFT v6.1 and later

  • Property HasPrivate As Boolean read-only

    • Retrieves "true" if the key pair includes the private SSH key.

    HRESULT HasPrivate ([out, retval] BSTR* pVal);

    Example (VBScript):

    For Each key In Site.SSHKeys
    If (True = key.HasPrivate) Then
    MsgBox key.Name & " Has private key"
    End If
Next

    EFT v8 and later

  • Property ID As Long read-only

    • Retrieves the ID of the SSH key. (Index in Site.SSHKeys array)

    HRESULT ID([out, retval] long* pVal);

    EFT v6.1 and later

  • Property Name As String read-only

    • Retrieves the name of the SSH key.

    HRESULT Name([out, retval] BSTR* pVal);

    EFT v6.1 and later

Examples (VBScript):

MsgBox "Key: " & key.Name & "(" & key.Fingerprint & ")" 
Client.SetSSHKeyID key.ID