dsmInitEx
Der Funktionsaufruf dsmInitEx startet eine API-Sitzung, indem er die zusätzlichen Parameter für die erweiterte Prüfung verwendet.
Syntax
dsInt16_t dsmInitEx (dsUint32_t *dsmHandleP,
dsmInitExIn_t *dsmInitExInP,
dsmInitExOut_t *dsmInitExOutP) ; Parameter
- dsUint32_t *dsmHandleP (O)
- Die Kennung, die diese Initialisierungssitzung identifiziert und nachfolgenden IBM® Storage Protect -Aufrufen zuordnet.
- dsmInitExIn_t *dsmInitExInP
- Diese Struktur enthält die folgenden Eingabeparameter:
- dsmApiVersion *dsmApiVersionP (I)
- Dieser Parameter ist ein Verweis auf die Datenstruktur, die die Version der API identifiziert, die der Anwendungsclient für diese Sitzung verwendet. Die Struktur enthält die Werte der vier Konstanten DSM_API_VERSION, DSM_API_RELEASE, DSM_API_LEVEL und DSM_API_SUBLEVEL, die in der Datei dsmapitd.h definiert sind. Rufen Sie dsmQueryApiVersionEx auf und stellen Sie sicher, dass die API-Version des Anwendungsclients und die Version der API-Bibliothek, die auf der Workstation des Benutzers installiert ist, kompatibel sind.
- char *clientNodeNameP (I)
- Dieser Parameter ist ein Zeiger auf den Knoten für die IBM Storage Protect -Sitzung. Alle Sitzungen müssen einem Knotennamen zugeordnet sein. Die Konstante DSM_MAX_NODE_LENGTH in der Datei dsmapitd.h legt die maximale Größe für einen Knotennamen fest.
Beim Knotennamen muss die Groß-/Kleinschreibung nicht beachtet werden.
Wenn dieser Parameter auf NULL und die Option passwordaccess auf prompt gesetzt wird, versucht die API, den Knotennamen zunächst aus der übergebenen Optionszeichenfolge abzurufen. Ist er dort nicht vorhanden, versucht die API anschließend, den Knotennamen aus der Konfigurationsdatei oder der Optionsdatei abzurufen. Wenn diese Versuche, den Knotennamen zu finden, fehlschlagen, verwendet die UNIX-oder Linux® -API den Systemhostnamen, während die APIs von anderen Betriebssystemen zurückgegeben werden.DSM_RC_REJECT_ID_UNKNOWN.
Wenn dieser Parameter NULL ist und die Option passwordaccess in der Datei dsm.opt (für die Windows-API) oder in der Datei dsm.sys (für die UNIX-oder Linux -API) auf generategesetzt ist, verwendet die API den Wert der Option nodename oder den Namen des Systemhosts.
- char *clientOwnerNameP (I)
- Dieser Parameter ist ein Zeiger auf den Eigner der IBM Storage Protect -Sitzung. Wenn das
Betriebssystem eine Mehrbenutzerplattform ist, hat
der Eignername NULL (der Rootbenutzer) die Berechtigung zum Sichern, Archivieren,
Zurückschreiben oder Abrufen von Objekten, die zu der Anwendung gehören, unabhängig vom
Eigner des Objekts.
Beim Eignernamen muss die Groß-/Kleinschreibung beachtet werden.
Wenn dieser Parameter NULL ist und die Option passwordaccess in der Datei dsm.sys auf generate gesetzt wird, verwendet die API die Anmelde-Benutzer-ID.
Hinweis: Auf einer Mehrbenutzerplattform muss der Eignername nicht mit der aktiven Benutzer-ID der Sitzung übereinstimmen, in der die Anwendung ausgeführt wird. - char *clientPasswordP (I)
- Ein Zeiger auf das Kennwort des Knotens, auf dem die IBM Storage Protect -Sitzung ausgeführt wird. Mit der Konstanten DSM_MAX_VERIFIER_LENGTH in der Datei dsmapitd.h wird die maximale Größe festgelegt, die für ein Kennwort zulässig
ist.
Für das Kennwort muss die Groß-/Kleinschreibung nicht beachtet werden.
Außer wenn die Kennwortdatei zuerst gestartet wird, wird der Wert dieses Parameters ignoriert, wenn die Option passwordaccess auf generate gesetzt ist.
- char *userNameP;
- Ein Verweis auf den Namen des Benutzers mit Verwaltungsaufgaben, der über Clientberechtigung für diesen Knoten verfügt.
- char *userPasswordP;
- Ein Verweis auf das Kennwort für den Parameter userName, sofern ein Wert angegeben ist.
- char *applicationType (I)
- Gibt die Anwendung an, die die IBM Storage Protect -Sitzung ausführt. Der Anwendungsclient identifiziert den Wert.
Jedes Mal, wenn ein API-Anwendungsclient eine Sitzung mit dem Server startet, wird der Anwendungstyp (bzw. das Betriebssystem) des Clients auf dem Server aktualisiert. Der Wert wird in das Feld platform auf dem Server eingegeben. Ziehen Sie die Verwendung einer Betriebssystem-ID im Wert in Betracht. Die maximale Länge der Zeichenfolge wird in der Konstanten DSM_MAX_PLATFORM_LENGTH definiert.
Um den aktuellen Wert des Anwendungstyps anzuzeigen, rufen Sie dsmQuerySessInfoauf.
- char *configfile (I)
- Verweist auf eine Zeichenfolge, die den vollständig qualifizierten Namen einer API-Konfigurationsdatei enthält. Optionen, die in der API-Konfigurationsdatei angegeben werden, überschreiben die entsprechende Angabe in der Clientoptionsdatei. Optionsdateien werden definiert, wenn IBM Storage Protect (Client oder API) installiert wird.
- char *options (I)
- Verweist auf eine Zeichenfolge, die Benutzeroptionen wie die folgenden
enthalten kann:
- Compressalways
- Servername (nur UNIX-und Linux -Systeme)
- TCPServeraddr (nicht für UNIX-Systeme)
- Von Knoten
- Fromowner
- Passwordaccess
Der Anwendungsclient kann die Werte für diese Optionen, die in der Konfigurationsdatei definiert sind, mithilfe der Optionsliste überschreiben.
Optionen weisen das folgende Format auf:
- Jede Option, die in der Optionsliste angegeben ist, beginnt mit einem Gedankenstrich (-) gefolgt vom Optionsschlüsselwort.
- Auf das Schlüsselwort folgt ein Gleichheitszeichen (=) und dann der Optionsparameter.
- Wenn der Optionsparameter ein Leerzeichen enthält, schließen Sie den Parameter in Hochkommas oder Anführungszeichen ein.
- Wenn mehrere Optionen angegeben werden, trennen Sie die einzelnen Optionen jeweils durch ein Leerzeichen voneinander.
Wenn Optionen NULL sind, werden die Werte für alle Optionen aus der Benutzeroptionsdatei oder der API-Konfigurationsdatei übernommen.
- dirDelimiter
- Der Verzeichnisbegrenzer, der als Präfix vor Dateibereichsnamen, übergeordneten und untergeordneten Namen angegeben wird. Sie müssen den Parameter dirDelimiter nur angeben, wenn die Anwendung die Systemstandardwerte überschreibt. In einer UNIX-oder Linux -Umgebung ist der Standardwert ein Schrägstrich (/). In einer Windows-Umgebung ist der Standardwert ein Backslash (\).
- useUnicode
- Ein boolesches Flag, das angibt, ob Unicode aktiviert ist. Das Flag useUnicode muss auf false gesetzt sein, um plattformübergreifende Interoperabilität zwischen UNIX-und Windows-Systemen zu erreichen.
- bCrossPlatform
- Ein boolesches Flag, das gesetzt werden muss (bTrue), um eine plattformübergreifende Interoperabilität zwischen UNIX-und Windows-Systemen zu erreichen. Wenn das Flag bCrossPlatform gesetzt ist, stellt die API sicher, dass für die Dateibereiche nicht Unicode verwendet wird und die Anwendung nicht Unicode verwendet. Eine Windows-Anwendung, die Unicode verwendet, ist nicht mit Anwendungen kompatibel, die Nicht-Unicode-Codierungen verwenden. Das Flag bCrossPlatform darf nicht für eine Windows-Anwendung gesetzt werden, die Unicode verwendet.
- UseTsmBuffers
- Gibt an, ob die Pufferkopieneliminierung verwendet werden soll.
- numTsmBuffers
- Anzahl Puffer, wenn
useTsmBuffers=bTruegesetzt ist. - bEncryptKeyEnabled
- Gibt an, ob Verschlüsselung mit anwendungsverwaltetem Schlüssel verwendet wird.
- encryptionPasswordP
- Das Verschlüsselungskennwort.Einschränkung: Wenn
encryptkey=saveist und ein Verschlüsselungsschlüssel vorhanden ist, wird der in encryptionPasswordP angegebene Wert ignoriert. - dsmAppVersion *appVersionP (I)
- Dieser Parameter ist ein Verweis auf die Datenstruktur, die die Versionsinformationen der Anwendung enthält, die eine API-Sitzung startet. Die Struktur enthält die Werte für die vier Konstanten applicationVersion, applicationRelease, applicationLevel und applicationSubLevel, die in der Datei tsmapitd.h definiert werden.
- dsmInitExOut_t *dsmInitExOut P
- Diese Struktur enthält die Ausgabeparameter.
- dsUint32_t *dsmHandle (0)
- Die Kennung, die diese Initialisierungssitzung identifiziert und nachfolgenden API-Aufrufen zuordnet.
- infoRC
- Zusätzliche Informationen zum Rückkehrcode. Überprüfen Sie sowohl den Funktionsrückkehrcode als auch den Wert von infoRC. Der infoRC -Wert DSM_RC_REJECT_LASTSESS_CANCELED (69) gibt IBM Storage Protect an, dass der Administrator die letzte Sitzung abgebrochen hat.
Rückkehrcodes
Die Rückkehrcodenummern sind in runden Klammern ( ) angegeben.
| Rückkehrcode | Erläuterung |
|---|---|
| DSM_RC_ABORT_SYSTEM_ERROR (1) | Der IBM Storage Protect -Server hat einen Systemfehler erkannt und die Clients benachrichtigt. |
| DSM_RC_REJECT_VERIFIER_EXPIRED (52) | Das Kennwort ist abgelaufen und muss aktualisiert werden. Der nächste Aufruf muss dsmChangePW sein und in diesem Aufruf muss die Kennung zurückgegeben werden. |
| DSM_RC_REJECT_ID_UNKNOWN (53) | Der Knotenname wurde nicht gefunden. |
| DSM_RC_TA_COMM_DOWN (103) | Die Datenübertragungsverbindung ist inaktiv. |
| DSM_RC_AUTH_FAILURE (137) | Es ist ein Authentifizierungsfehler aufgetreten. |
| DSM_RC_NO_STARTING_DELIMITER (148) | Das Muster enthält keinen Startbegrenzer. |
| DSM_RC_NEEDED_DIR_DELIMITER (149) | Direkt vor und hinter der Metazeichenfolge (...) für den Verzeichnisabgleichist ein Verzeichnisbegrenzer erforderlich, es wurde jedoch keiner gefunden. |
| DSM_RC_NO_PASS_FILE (168) | Die Kennwortdatei ist nicht verfügbar. |
| DSM_RC_UNMATCHED_QUOTE (177) | Die Optionszeichenfolge enthält ein Anführungszeichen ohne Entsprechung. |
| DSM_RC_NLS_CANT_OPEN_TXT (0610) | Die Nachrichtentextdatei kann nicht geöffnet werden. |
| DSM_RC_INVALID_OPT (2013) | Ein Eintrag in der Optionszeichenfolge ist ungültig. |
| DSM_RC_INVALID_DS_HANDLE (2014) | Ungültige DSM-Kennung. |
| DSM_RC_NO_OWNER_REQD (2032) | Der Eignerparameter muss NULL sein, wenn die Option passwordaccess auf generate gesetzt ist. |
| DSM_RC_NO_NODE_REQD (2033) | Der Knotenparameter muss NULL sein, wenn passwordaccess auf 'generate' gesetzt ist. |
| DSM_RC_WRONG_VERSION (2064) | Die API-Version des Anwendungsclients hat einen höheren Wert als die IBM Storage Protect -Version. |
| DSM_RC_PASSWD_TOOLONG (2103) | Das angegebene Kennwort ist zu lang. |
| DSM_RC_NO_OPT_FILE (2220) | Es wurde keine Konfigurationsdatei gefunden. |
| DSM_RC_INVALID_KEYWORD (2221) | Ein in einer Optionszeichenfolge angegebenes Schlüsselwort ist ungültig. |
| DSM_RC_PATTERN_TOO_COMPLEX (2222) | Einschluss-/Ausschlussmuster zu komplex, um von IBM Storage Protectinterpretiert zu werden. |
| DSM_RC_NO_CLOSING_BRACKET (2223) | Das Muster enthält keine rechte eckige Klammer. |
| DSM_RC_INVALID_SERVER (2225) | Für eine Mehrplatzsystemumgebung wurde der Server in der Systemkonfigurationsdatei nicht gefunden. |
| DSM_RC_NO_HOST_ADDR (2226) | Nicht genügend Informationen, um die Verbindung zum Host herzustellen. |
| DSM_RC_MACHINE_SAME (2227) | Der Knotenname, der in der Optionsdatei definiert ist, darf nicht mit dem Systemhostnamen übereinstimmen. |
| DSM_RC_NO_API_CONFIGFILE (2228) | Die Konfigurationsdatei kann nicht geöffnet werden. |
| DSM_RC_NO_INCLEXCL_FILE (2229) | Die Einschluss-/Ausschlussdatei wurde nicht gefunden. |
| DSM_RC_NO_SYS_OR_INCLEXCL (2230) | Die Datei dsm.sys oder die Einschluss-/Ausschlussdatei wurde nicht gefunden. |