|
GET_CONSOLE |
Ereignis-Behandlung |
GET_WIN_EVENT |
|
Script-Funktion: Ermittelt von einem Rechner ab einem definierten Pfad verschiedene Dateisystemwerte.
GET_FILESYSTEM([Host], [Path], FileSystem Value,[Unit], [Include sub-directories], [Login object])
|
Syntax |
Beschreibung/Format |
|---|---|
|
Host |
Name des Agenten, der auf dem Rechner läuft, von dem Informationen ermittelt werden sollen. Format: AE-Name, Script-Literal oder Script-Variable. Geben Sie den Hostnamen nicht an, so wird der zuletzt mit der Script-Funktion GET_FILESYSTEM benutzte Agent verwendet. Die Werte werden nicht neu ermittelt, sondern nur jene des letzten Aufrufs ausgegeben. Wenn für ein Ereignis-Objekt in der Registerkarte Script kein Agent definiert ist, wird der Wert aus dem Ergebnis des Ereignisses gelesen und nicht mehr abgefragt (d. h. es werden Werte aus der Datenbank, die von diesem Ereignis gespeichert wurden, abgefragt). Sie können den Agenten auf der Registerkarte Script für Ereignis-Objekte mit einer ausgefüllten zweiten Combobox (z. B. FILE_CHANGED/FILE_STABLE in der Box Ereignis auf der Registerkarte Dateisystem) nicht unspezifiziert lassen, da solche Ereignisse keine Metriken für dieses Ereignis in der Datenbank speichern. |
|
Pfad |
Angabe zu Dateien oder Dateisystemen, zu denen Informationen ermittelt werden sollen. Hier können, abhängig vom jeweiligen Zielsystem, Dateinamen, Laufwerke, Volumes, Pfade, Kennungen, Generation Data Groups (GDG) etc. qualifiziert oder teilqualifiziert benannt werden. Es können die Wildcardzeichen "*" oder "?" verwendet werden. "*" steht dabei für beliebige, "?" für genau ein Zeichen. Beachten Sie, dass bei Windows die Wildcardzeichen "*" und "?" nur für den Dateinamen, nicht aber für Verzeichnisse innerhalb des Pfads verwendet werden können! Die Zeichen * und ? werden immer als Wildcards angewendet. Es ist daher nicht möglich, gezielt Dateien anzugeben, welche diese Zeichen im Namen aufweisen. Format: AE-Name, Script-Literal oder Script-Variable Geben Sie den Pfadnamen nicht an, so wird der zuletzt mit der Script-Funktion GET_FILESYSTEM benutzte Pfadname verwendet. Die Werte werden nicht neu ermittelt, sondern nur jene des letzten Aufrufs ausgegeben. Schließen Sie die Pfadangaben auf Windows unbedingt mit einem "\*" ab. Nur so erhalten Sie mit den Script-Funktionen zur Fehlerbehandlung eine Fehlermeldung, wenn der Pfad nicht existiert. Beispiel: C:\AUTOMIC\* Die Angabe eines oder mehrerer Volumes benötigt das Prefix "VOL=". Beispiele: "VOL=ALG*1" liefert Information zu allen Volumes, welche mit "ALG" beginnen, und mit "1" enden. Dazwischen dürfen beliebige Zeichen vorkommen. Hier sind es genau vier beliebige Zeichen, da die Bezeichnung eines Volumes 8-stellig ist. Bei der Bezeichnung von Generation Data Groups darf das Wildcardzeichen "*" nur innerhalb der Klammern verwendet werden. |
|
Dateisystem-Wert |
Die Script-Funktion kann folgende Informationen ermitteln: PATH_SPACE_ALLOCATED - Zugeteilter Speicher- bzw. Plattenplatz. Format: AE-Name, Script-Literal oder Script-Variable |
|
Maßeinheit |
Optional kann angegeben werden, in welcher Form Dateisystem-Wert zurückgeben werden soll. Ohne Maßeinheit wird der Rückgabewert durch den Host bestimmt (Standard). Ein BS2000-Rechner gibt beispielsweise den Wert "1" für 1 PAM-Seite zurück. Das entspricht 2048 Bytes. Mit Maßeinheit wird der Rückgabewert wie angegeben umgerechnet. Format: AE-Name, Script-Literal oder Script-Variable Bei der Angabe einer ungültigen Maßeinheit wird ebenfalls der Standardwert verwendet. Die Script-Funktion bricht daher auch dann nicht ab, wenn Sie :ON_ERROR einsetzen. |
| Unterverzeichnisse einbeziehen |
Beeinflusst, ob die Unterverzeichnisse des angegebenen Pfades durchsucht werden sollen. Erlaubte Werte: "Y" (Standardwert) und "N" Der Parameter ist nur für VMS-, UNIX- und Windows-Agenten wirksam. Beachten Sie, dass die Performance des Automation Engine-Systems belastet wird, wenn Sie diese Option aktivieren! |
| Login-Objekt | Name des im Voraus definierten Login-Objektes; dient zum Transfer von Logindaten für das Dateisystem-Ereignis-Objekt (FileEvent). |
|
Rückgabewerte |
|---|
|
Ergebnis für den gesuchten Dateisystem-Wert |
Dieses Sprachmittel kann nur in Zusammenhang mit Betriebssystem-Agenten (Windows, UNIX, VMS, z/OS, OS/400, NSK und BS2000) verwendet werden!
Tritt beim Zugriff auf Informationen zum Dateisystem ein Fehler auf (z.B: Pfad nicht gefunden), ist der Rückgabewert "0".
Mit der Script-Anweisung :ON_ERROR legen Sie die Reaktion auf diesen Fehler fest. Wie bisher können Sie ihn mit den Script-Funktionen zur Fehlerbehandlung analysieren. Das Script wird weiter prozessiert. Es besteht aber auch die Möglichkeit, die Prozessierung des Scripts abzubrechen.
Bei PATH_FILE_COUNT kann die Funktion natürlich auch 0 zurückliefern, wenn keine Dateien im Verzeichnis vorhanden sind. Verwenden Sie daher zusätzlich die Script-Funktionen zur Fehlerbehandlung (z.B. SYS_LAST_ERR_NR), um Fehler entdecken zu können. Beispielsweise, wenn der Host nicht aktiv ist. So ist es möglich zu unterscheiden, ob sich der Rückgabewert 0 auf die Dateianzahl oder auf einen aufgetretenen Fehler bezieht.
Bei fehlender Zugriffsberechtigung auf Systemordner (System Volume Information, Windows) wird ebenfalls Rückgabewert 0 ausgegeben.
Das Script-Sprachmittel bewirkt, dass die offenen Transaktionen des Scripts in die Datenbank geschrieben werden.
Optionale Parameter Host und Pfad
Beispiel 1:
GET_FILESYSTEM kann in den Script-Registerkarten von allen aktivierbaren Objekten (z.B. Workflow) verwendet werden. Beim Aufruf der Script-Funktion ist immer ein Host und ein Pfad anzugeben. Die Parameter können nur dann weggelassen werden, wenn GET_FILESYSTEM im Script schon einmal aufgerufen wurde. Sie erhalten aber in diesem Fall denselben Wert wie beim vorigen Aufruf. Es folgt dazu ein Beispiel:
:SET &NumberFiles# = GET_FILESYSTEM(WIN01, "C:\Temp", PATH_FILE_COUNT)
!several script lines
:SET &NumberFiles# = GET_FILESYSTEM(,, PATH_FILE_COUNT)
!several script lines
:SET &NumberFiles# = GET_FILESYSTEM(WIN01, "C:\Temp", PATH_FILE_COUNT)
Der erste Aufruf von GET_FILESYSTEM liefert die Dateianzahl im Verzeichnis C:\Temp (z.B. 50). Sollten jetzt Dateien in diesem Ordner gelöscht werden, gibt die zweite Verwendung der Script-Funktion auch weiterhin 50 aus. Der dritte Aufruf jedoch ermittelt die Dateisystem-Werte neu und liefert eine niedrigere Dateianzahl.
Beispiel 2:
Beim Eintreten eines Ereignisses vom Typ "Dateisystem", kann mit der Script-Funktion GET_FILESYSTEM auf eine Reihe Informationen zum Dateisystem und der Ausnutzung des Speicher- bzw. Plattenplatzes zugegriffen werden. Vom Agenten werden dabei alle Informationen übermittelt, die dann einzeln unter Angabe von Dateisystem-Wert abgefragt werden können. Die Script-Funktion wird dabei ohne Angabe von Host und Pfad aufgerufen, da diese bereits in der Registerkarte Dateisystem des Ereignisses definiert sind.
OS/400: Besonderheiten bei Dateisystem-Werten
Geben Sie immer sowohl eine Bibliothek als auch eine Datei an, um gültige Werte zum Dateisystem zu erhalten.
z/OS: Besonderheiten bei Dateisystem-Werten
PATH_SPACE_ALLOCATED - Der zugewiesene Speicherplatz in z/OS kann nicht ermittelt werden. Die Funktion gibt den benützten Speicherplatz zurück.
PATH_SPACE_USED - Benutzter Speicherplatz
PATH_SPACE_UNUSED - Ist immer Null, da dieser Wert die Differenz von PATH_SPACE_ALLOCATED und PATH_SPACE_USED ist.
Bei der Angabe einer GDG-Bezeichnung kann die Script-Funktion die folgenden Dateisystem-Werte ermitteln: PATH_SPACE_USED und PATH_FILE_COUNT.
Besonderheiten bei Dateisystem-Werten BS2000 gegenüber anderen Betriebssystemen
Nur in BS2000 können sich zugeteilter und benutzter Speicherplatz unterscheiden. Dort werden beispielsweise für eine Datei 1000 PAM-Seiten reserviert. Der Inhalt der Datei beträgt aber nur 100 PAM-Seiten.
Bei anderen Betriebssystemen, wie UNIX, VMS und MPE gilt folgendes:
PATH_FILE_COUNT - Anzahl der Dateien.
PATH_FOLDER_COUNT - Anzahl der Ordner.
PATH_SPACE_USED - Summe der Dateigrößen im angegebenen Pfad.
PATH_SPACE_TOTAL - ist mit PATH_SPACE_USED und PATH_SPACE_ALLOCATED identisch.
Das Beispiel nutzt die Script-Funktion GET_FILESYSTEM, um die Anzahl vorhandener Dateien zu ermitteln und eine entsprechende Meldung abzusetzen. Da die beiden ersten Parameter nicht angegeben wurden, handelt es sich um den Script-Auszug eines Ereignisses.
:SET &NUMBER# = GET_FILESYSTEM(,,PATH_FILE_COUNT)
:SEND_MSG "BROWN","IT","&NUMBER# files are available for processing."
Im folgenden Beispiel wird die Script-Funktion GET_FILESYSTEM im Script eines Jobs verwendet. Es werden alle verfügbaren Informationen zum Laufwerk abgerufen und im Aktivierungsprotokoll ausgegeben.
: SET &E1# = GET_FILESYSTEM(WIN01,"E:\",FILESYSTEM_SPACE_TOTAL,MB)
: SET &E2# = GET_FILESYSTEM(,,FILESYSTEM_SPACE_USED,MB)
: SET &E3# = GET_FILESYSTEM(,,FILESYSTEM_SPACE_FREE,MB)
: PRINT "Memory capacity of the drive: &E1# MB"
: PRINT "Used
drive space: &E2# MB"
: PRINT
"Available space: &E3# MB"
Die folgende Beispiele zeigen die Verwendung der Script-Funktion mit GDG:
!Number of file generations of the group TEST.XXX
:SET &FILENAME# = GET_FILESYSTEM("MVSHOST", "TEST.XXX(*)",
PATH_FILE_COUNT)
!Sum of the space used by the current generation
:SET &SPACE# = GET_FILESYSTEM("MVSHOST", "TEST.XXX(0)",
PATH_SPACE_USED)
Siehe auch:
| Script-Sprachmittel | Beschreibung |
|---|---|
| Legt die Reaktion auf bestimmte Fehler bzw. Meldungen von Script-Sprachmitteln fest. |
Script-Sprachmittel - Ereignisbehandlung
Beispielsammlung:
Darstellungen mittels Cockpit
Allgemeines zum Script
Script-Sprachmittel - Alphabetische Auflistung
Script-Sprachmittel - Funktionelle Gliederung
|
Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support |
Copyright © 2016 Automic Software GmbH |