Sun Cluster Entwicklerhandbuch Datendienste für Solaris OS

RMAPI-Zugriffsmethoden

Die API bietet Funktionen für den Zugriff auf Ressourcentyp-, Ressourcen- und Ressourcengruppeneigenschaften sowie andere Cluster-Informationen. Diese Funktionen stehen in Form von Shell-Befehlen und C-Funktionen zur Verfügung, mit denen Sie Steuerungsprogramme als Shell-Skripts oder als C-Programme implementieren können.

RMAPI-Shell-Befehle

Shell-Befehle werden in Shell-Skript-Implementierungen der Rückmeldemethoden für Ressourcentypen verwendet, die Dienste darstellen, die vom Cluster-RGM gesteuert werden. Mit diesen Befehlen können Sie folgende Aufgaben durchführen:


Hinweis –

Dieser Abschnitt enthält zwar kurze Beschreibungen der Shell-Befehle, auf der Online-Dokumentationsseite 1HA finden Sie jedoch die maßgebliche Referenz für die Shell-Befehle. Wenn nicht anderweitig angegeben, ist mit jedem Befehl eine Online-Dokumentationsseite verknüpft, die denselben Namen aufweist.


RMAPI-Ressourcenbefehle

Sie können auf die Informationen über eine Ressource zugreifen oder die Eigenschaften Status und Status_msg einer Ressource mit diesen Befehlen festlegen.

scha_resource_get

Ruft Informationen über eine Ressource oder einen Ressourcentyp auf, der von RGM gesteuert wird. Dieser Befehl bietet dieselben Informationen wie die scha_resource_get()-C-Funktion. Weitere Informationen finden Sie in der Online-Dokumentation zu scha_resource_get(1HA).

scha_resource_setstatus

Legt die Eigenschaften Status und Status_msg einer Ressource fest, die von RGM gesteuert wird. Dieser Befehl wird vom Ressourcenmonitor verwendet, um den Zustand der Ressource aus Monitorsicht anzugeben. Dieser Befehl bietet dieselbe Funktionalität wie die scha_resource_get()-C-Funktion. Dieser Befehl wird in der Online-Dokumentation zu scha_resource_setstatus(1HA) detailliert beschrieben.


Hinweis –

scha_resource_setstatus()ist zwar für einen Ressourcen-Monitor besonders nützlich, kann jedoch von jedem beliebigen Programm aufgerufen werden.


Ressourcentyp-Befehl

scha_resourcetype_get

Ruft Informationen über eine in RGM registrierte Ressource auf. Dieser Befehl bietet die gleiche Funktionalität wie die C-Funktion scha_resourcetype_get(). Dieser Befehl wird in der Online-Dokumentation zu scha_resourcetype_get(1HA) detailliert beschrieben.

Ressourcengruppe-Befehle

Mit diesen Befehlen können Sie auf Informationen über eine Ressourcengruppe zugreifen oder eine Ressourcengruppe neu starten.

scha_resourcegroup_get

Ruft Informationen über eine von RGM gesteuerte Ressourcengruppe auf. Dieser Befehl bietet die gleiche Funktionalität wie die C-Funktion scha_resourcetype_get(). Dieser Befehl wird in der Online-Dokumentation zu scha_resourcegroup_get(1HA) detailliert beschrieben.

scha_control

Fordert den Neustart einer von RGM gesteuerten Ressourcengruppe oder ihre Verschiebung auf einen anderen Knoten an. Dieser Befehl bietet die gleiche Funktionalität wie die C-Funktion scha_control(). Dieser Befehl wird in der Online-Dokumentation zu scha_control(1HA) detailliert beschrieben.

Cluster-Befehl

scha_cluster_get

Ruft Informationen über einen Cluster auf, z.B. den Clusternamen, die Knotennamen, die IDs, die Zustände und Ressourcengruppen. Dieser Befehl bietet dieselben Informationen wie die scha_cluster_get()-C-Funktion. Dieser Befehl wird in der Online-Dokumentation zu scha_cluster_get(1HA) detailliert beschrieben.

C-Funktionen

C-Funktionen werden in C-Programmimplementierungen der Rückmeldemethoden für Ressourcentypen verwendet, die von Cluster-RGM gesteuerte Dienste darstellen. Mit diesen Funktionen können Sie folgende Aufgaben durchführen:


Hinweis –

Dieser Abschnitt enthält zwar kurze Beschreibungen der C-Funktionen, auf der Online-Dokumentationsseite 3HA finden Sie jedoch die maßgebliche Referenz für die C-Funktionen. Wenn nicht anderweitig angegeben, ist mit jeder Funktion eine Online-Dokumentationsseite verknüpft, die denselben Namen aufweist. Weitere Informationen zu den Ausgabeargumenten und Rückgabecodes der C-Funktionen finden Sie in der Online-Dokumentation zu scha_calls(3HA).


Ressourcenfunktionen

Mit diesen Funktionen rufen Sie Informationen über eine von RGM gesteuerte Ressource auf oder geben den Zustand der Ressource aus Monitorsicht an.

scha_resource_open(), scha_resource_get () und scha_resource_close()

Diese Funktionen rufen Informationen über eine vom RGM verwaltete Ressource auf. Die scha_resource_open()-Funktion initialisiert den Zugriff auf eine Ressource und gibt einen Handle für scha_resource_get() für den Zugriff auf die Ressourceninformationen zurück. Die scha_resource_close()-Funktion macht den Handle ungültig und setzt Speicher frei, der für die scha_resource_get ()-Rückgabewerte zugewiesen wurde.

Eine Ressource kann sich ändern, entweder über eine Cluster-Neukonfiguration oder Verwaltungsaktion, nachdem scha_resource_open() den Ressourcen-Handle zurückgibt. Folglich können die Informationen, die scha_resource_get() über den Handle erhält, ungenau sein. Im Falle einer Cluster-Neukonfiguration oder im Falle von Verwaltungsaktionen für eine Ressource gibt RGM den scha_err_seqid-Fehlercode an scha_resource_get() aus, um anzugeben, dass die Informationen über die Ressource eventuell geändert wurden. Diese Fehlermeldung meldet keinen schwerwiegenden Fehler. Die Funktion gibt Erfolg zurück. Sie können die Meldung ignorieren und die zurückgegebenen Informationen annehmen. Als Alternative können Sie den aktuellen Handle schließen und einen neuen Handle für den Zugriff auf Informationen über die Ressource öffnen.

Diese drei Funktionen werden auf einer Online-Dokumentationsseite beschrieben. Sie können diese Online-Dokumentationsseite mit den Funktionen scha_resource_open(3HA), scha_resource_get(3HA) und scha_resource_close(3HA) aufrufen.

scha_resource_setstatus()

Legt die Eigenschaften Status und Status_msg einer von RGM gesteuerten Ressource fest. Der Ressourcen-Monitor verwendet diese Funktion, um den Ressourcenzustand anzugeben.


Hinweis –

scha_resource_setstatus()ist zwar für einen Ressourcen-Monitor besonders nützlich, kann jedoch von jedem beliebigen Programm aufgerufen werden.


Ressourcentypfunktionen

Mit diesen Funktionen werden Informationen über einen in RGM registrierten Ressourcentyp aufgerufen.

scha_resourcetype_open(), scha_resourcetype_get () und scha_resourcetype_close()

Die scha_resourcetype_open()-Funktion initialisiert den Zugriff auf eine Ressource und gibt einen Handle für scha_resourcetype_get() zurück, mit dem auf die Ressourceninformationen zugegriffen wird. Die scha_resourcetype_close()-Funktion macht den Handle ungültig und setzt Speicher frei, der für die scha_resourcetype_get ()-Rückgabewerte zugewiesen wird.

Eine Ressource kann sich ändern, entweder über eine Cluster-Neukonfiguration oder Verwaltungsaktionen, nachdem scha_resourcetype_open() den Ressourcentyp-Handle ausgibt. Folglich können die Informationen, die scha_resourcetype_get() über den Handle erhält, ungenau sein. Im Falle einer Cluster-Neukonfiguration oder im Falle von Verwaltungsaktionen für eine Ressource gibt RGM den scha_err_seqid-Fehlercode an scha_resourcetype_get() aus, um anzugeben, dass die Informationen über die Ressource eventuell geändert wurden. Diese Fehlermeldung meldet keinen schwerwiegenden Fehler. Die Funktion gibt Erfolg zurück. Sie können die Meldung ignorieren und die zurückgegebenen Informationen annehmen. Als Alternative können Sie den aktuellen Handle schließen und einen neuen Handle für den Zugriff auf Informationen über den Ressourcentyp öffnen.

Diese drei Funktionen werden auf einer Online-Dokumentationsseite beschrieben. Sie können diese Online-Dokumentationsseite mit den Funktionen scha_resourcetype_open(3HA), scha_resourcetype_get(3HA) und scha_resourcetype_close(3HA) aufrufen.

Ressourcengruppenfunktionen

Mit den folgenden Funktionen können Sie Informationen über eine Ressourcengruppe aufrufen oder eine Ressourcengruppe neu starten.

scha_resourcegroup_open(), scha_resourcegroup_get () und scha_resourcegroup_close()

Diese Funktionen rufen Informatinen über eine von RGM verwaltete Ressource auf. Die Funktion scha_resourcegroup_open() initialisiert den Zugriff auf eine Ressourcengruppe und gibt einen Handle für scha_resourcegroup_get() zurück, womit auf die Ressourcengruppeninformationen zugegriffen wird. Die scha_resourcegroup_close()-Funktion macht den Handle ungültig und setzt Speicher frei, der für die scha_resourcegroup_get ()-Rückgabewerte zugewiesen wird.

Eine Ressource kann sich ändern, entweder über eine Cluster-Neukonfiguration oder Verwaltungsaktionen, nachdem scha_resourcegroup_open() den Ressourcengruppen-Handle zurückgibt. Folglich können die Informationen, die scha_resourcegroup_get() über den Handle erhält, ungenau sein. Im Falle einer Cluster-Neukonfiguration oder im Falle von Verwaltungsaktionen für eine Ressource gibt RGM den scha_err_seqid-Fehlercode an scha_resourcegroup_get() aus, um anzugeben, dass die Informationen über die Ressource eventuell geändert wurden. Diese Fehlermeldung meldet keinen schwerwiegenden Fehler. Die Funktion gibt Erfolg zurück. Sie können die Meldung ignorieren und die zurückgegebenen Informationen annehmen. Als Alternative können Sie den aktuellen Handle schließen und einen neuen Handle für den Zugriff auf Informationen über die Ressourcengruppe öffnen.

Diese drei Funktionen werden auf einer Online-Dokumentationsseite beschrieben. Sie können diese Online-Dokumentation mit den Funktionen scha_resourcegroup_open(3HA), scha_resourcegroup_get(3HA) und scha_resourcegroup_close(3HA) aufrufen.

scha_control()

Fordert den Neustart einer von RGM gesteuerten Ressourcengruppe oder ihre Verschiebung auf einen anderen Knoten an. Diese Funktion wird in der Online-Dokumentation zu scha_control(3HA) detailliert beschrieben.

Cluster-Funktionen

Diese Funktionen rufen Informationen über einen Cluster auf oder geben sie zurück.

scha_cluster_open(), scha_cluster_get () und scha_cluster_close()

Diese Funktionen rufen Informationen über einen Cluster auf, z.B. den Clusternamen, die Knotennamen, die IDs, die Zustände und Ressourcengruppen.

Ein Cluster kann sich ändern, entweder über eine Neukonfiguration oder Verwaltungsaktionen, nachdem scha_cluster_open() den Cluster-Handle ausgibt. Folglich können die Informationen, die scha_cluster_get() über den Handle erhält, ungenau sein. Im Falle einer Cluster-Neukonfiguration oder im Falle von Verwaltungsaktionen auf einem Cluster gibt RGM den scha_err_seqid-Fehlercode an scha_cluster_get() aus, um anzugeben, dass die Informationen über den Cluster eventuell geändert wurden. Diese Fehlermeldung meldet keinen schwerwiegenden Fehler. Die Funktion gibt Erfolg zurück. Sie können die Meldung ignorieren und die zurückgegebenen Informationen annehmen. Als Alternative können Sie den aktuellen Handle schließen und einen neuen Handle für den Zugriff auf Informationen über den Cluster öffnen.

Diese drei Funktionen werden auf einer Online-Dokumentationsseite beschrieben. Sie können diese Online-Dokumentation mit den Funktionen scha_cluster_open(3HA), scha_cluster_get(3HA) und scha_cluster_close(3HA) aufrufen.

scha_cluster_getlogfacility()

Gibt die Nummer der Systemprotokollierungsoption, die als Cluster-Protokoll verwendet wird, aus. Sie verwendet den zurückgegebenen Wert mit der syslog()-Solaris-Funktion, um Ereignisse und Statusmeldungen im Cluster-Protokoll aufzuzeichnen. Diese Funktion wird in der Online-Dokumentation zu scha_cluster_getlogfacility(3HA) detailliert beschrieben.

scha_cluster_getnodename()

Gibt den Namen des Cluster-Knotens zurück, auf dem die Funktion aufgerufen wird. Diese Funktion wird in der Online-Dokumentation zu scha_cluster_getnodename(3HA) detailliert beschrieben.

Dienstprogrammfunktion

Mit dieser Funktion wird ein Fehlercode in eine Fehlermeldung umgewandelt.

scha_strerror()

Übersetzt einen Fehlercode, der von einer der scha_-Funktionen in eine entsprechende Fehlermeldung ausgegeben wird. Verwenden Sie diese Funktion mit dem Befehl logger, um Meldungen im Solaris-Systemprotokoll (syslog) aufzuzeichnen. Diese Funktion wird in der Online-Dokumentation zu scha_strerror(3HA) detailliert beschrieben.