GET_FILESYSTEM

Script-Funktion: Ruft mehrere Dateisystemwerte von einem definierten Pfad eines Computers ab.

Syntax

GET_FILESYSTEM ([Host],[Pfad],Dateisystemwert[,Einheit][, Unterverzeichnisse einbeziehen][,Login-Objekt])

Syntax	Beschreibung/Format
Host	Der Name des Agenten, der auf dem Computer aktiv ist, von dem die Informationen abgerufen werden sollen. Format: AE-Name, Script-Literal oder Script-Variable Hinweis: Wird der Hostname nicht angegeben, so wird der zuletzt mit der Script-Funktion GET_FILESYSTEM benutzte Agent verwendet. Es werden die Werte verwendet, die beim letzten Aufruf abgerufen wurden.
Pfad	Die Beschreibung von Dateien oder Dateisystemen, für die Informationen bereitgestellt werden sollen. Hier können, abhängig vom jeweiligen Zielsystem, Dateinamen, Laufwerke, Volumes, Pfade, Kennungen, Generierung von Datengruppen usw. qualifiziert oder teilqualifiziert angegeben werden. Es können die Platzhalterzeichen "" oder "?" verwendet werden. "" steht dabei für beliebige, "?" für genau ein Zeichen. Achtung! Beachten Sie, dass bei Windows die Platzhalterzeichen "" und "?" nur für die Dateinamen verwendet werden können. Sie können nicht für Verzeichnisse innerhalb des Pfades verwendet werden. Die Zeichen und ? werden immer als Platzhalterzeichen verwendet. Es ist daher nicht möglich, gezielt Dateien anzugeben, welche diese Zeichen im Namen aufweisen. Format: AE-Name, Script-Literal oder Script-Variable Hinweis: Wird der Pfadname nicht angegeben, so wird der zuletzt mit der Script-Funktion GET_FILESYSTEM benutzte Pfadname verwendet. Es werden die Werte verwendet, die beim letzten Aufruf ermittelt wurden. Hinweis: Die Pfadangaben unter Windows werden mit einem "\" beendet. Verwenden Sie Script-Funktionen, um Aktionen zu definieren, die im Fehlerfall durchgeführt werden sollen, z. B. das Senden einer Fehlermeldung, wenn der Pfad nicht vorhanden ist. Weitere Informationen finden Sie unter Script-Elemente zur Fehlerbehandlung. Beispiel:* C:\AUTOMIC\* Hinweis: Das Präfix "VOL=" wird benötigt, wenn ein oder mehrere Datenträger angegeben sind. Beispiel: "VOL=ALG1" liefert Informationen über alle Volumes, die mit den Buchstaben "ALG" beginnen und mit "1" enden. Es können beliebig viele Zeichen dazwischen kommen. Hier sind es genau vier beliebige Zeichen, da die Bezeichnung eines Volumens 8-stellig ist. Hinweis:* Wenn Sie Generation Data Groups benennen, setzen Sie das Platzhalterzeichen * in Klammern. Weitere Informationen finden Sie unter Unterstützung von GDG (Generation Data Groups).
Dateisystemwert	Die Script-Funktion kann folgende Informationen ermitteln: PATH_SPACE_ALLOCATED - Der zugewiesene Speicherplatz oder der Festplattenspeicher. PATH_SPACE_RELEASE - Der freigebbare Speicher (nur BS2000). PATH_SPACE_USED - Die Summe der Dateigrößen im angegebenen Pfad. PATH_SPACE_UNUSED - Nicht verwendeter Speicher oder Festplattenspeicher (nur BS2000). PATH_FILE_COUNT - Die Anzahl der Dateien. PATH_FOLDER_COUNT -Die Anzahl der Ordner (nur Windows, UNIX und OS/400). FILESYSTEM_SPACE_TOTAL - Der Gesamtspeicher der Festplatte (nur Windows und OS/400). FILESYSTEM_SPACE_USED - Verwendeter Speicher (nur Windows und OS/400). FILESYSTEM_SPACE_FREE - Freier Speicherplatz des Volumes (z/OS, OS/400) oder Laufwerk (Windows). Format: AE-Name, Script-Literal oder Script-Variable
Einheit	Es kann angegeben werden, in welcher Form ein Dateisystemwert zurückgegeben werden soll. Ohne eine Definition der Einheit wird der Rückgabewert vom Host bestimmt (Standard). Ein BS2000-Computer liefert z.B. den Wert "1" für eine PAM-Seite. Dies entspricht 2048 Bytes. Bei einer Definition der Einheit wird der Rückgabewert wie angegeben umgerechnet. Zulässige Werte: "Bytes", "KB", "MB", "GB" oder "TB". Format: AE-Name, Script-Literal oder Script-Variable Hinweis: Der Standardwert wird verwendet, wenn eine ungültige Einheit angegeben wurde. Aus diesem Grund wird diese Script-Funktion nicht abgebrochen, wenn Sie die Anweisung :ON_ERROR verwenden. Weitere Informationen finden Sie unter :ON_ERROR.
Unterverzeichnisse einbeziehen	Die Angabe, ob die Unterverzeichnisse des angegebenen Pfades durchsucht werden sollen. Zulässige Werte: "Y" (Standard) und "N" Der Parameter ist nur für VMS-, UNIX- und Windows-Agenten wirksam. Achtung! Die Aktivierung dieser Option kann die Performance Ihres AE-Systems belasten.
Login-Objekt	Name des zuvor definierten Login-Objekts; dient zur Übertragung der Login-Daten für das Dateisystem-Ereignisobjekt (optional)

Rückgabewerte
Ergebnis des gesuchten Dateisystemwerts. "0" - Beim Abrufen des Dateisystemwerts ist ein Fehler aufgetreten (Ausnahme: PATH_FILE_COUNT, siehe unten)

Achtung! Dieses Script-Element kann nur mit Betriebssystem-Agenten (Windows, UNIX, VMS, z/OS, OS/400, NSK und BS2000) verwendet werden.

Der Rückgabewert dieser Funktion ist Null, wenn beim Zugriff auf Informationen über das Dateisystem (z.B. Pfad nicht gefunden) ein Fehler auftritt.

Tipp: Verwenden Sie die Script-Anweisung :ON_ERROR, um Aktionen für den Fehlerfall zu definieren. Weitere Informationen finden Sie unter Script-Elemente zur Fehlerbehandlung.

Achtung! Wenn Sie diese Script-Funktion mit PATH_FILE_COUNT verwendet wird, kann sie 0 zurückgeben, wenn das Verzeichnis keine Dateien enthält. Verwenden Sie daher zusätzlich die Script-Funktionen für die Fehlerbehandlung (z. B. SYS_LAST_ERR_NR). Fehler (z.B. Host ist nicht aktiv) können so erkannt werden und es kann unterschieden werden, ob sich der Rückgabewert 0 auf die Dateinummer oder einen Fehler bezieht.

Achtung! Unter z/OS kann die zurückgegebene Datensatzgröße (PATH_SPACE_USED) ungenau sein, wenn der Datensatz auf EAV (Extended Address Volumes) liegt.

Achtung! Bei fehlender Zugriffsberechtigung auf Systemordner (System Volume Information, Windows) wird ebenfalls der Rückgabewert 0 ausgegeben.

Hinweise: Die Script-Anweisung bewirkt, dass alle offenen Transaktionen des Scripts in die AE-Datenbank geschrieben werden. Weitere Informationen finden Sie unter Script-Verarbeitung.

Optionale Parameter Host und Pfad

Beispiele

Beim Eintreten eines FILE-Ereignisses kann die Script-Funktion GET_FILESYSTEM verwendet werden, um Informationen über das Dateisystem, den Speicher und den Festplattenspeicher abzurufen. Jede Information wird zum Agenten transferiert. Jedes Element kann dann separat mit der Angabe des Dateisystemwertes abgefragt werden. Die Script-Funktion wird dabei ohne Angabe von Host und Pfad aufgerufen, da diese bereits in der Detail-Registerkarte des Ereignisses definiert sind.

GET_FILESYSTEM kann in den Prozess-Registerkarten aller ausführbaren Objekte (z. B. Workflows) verwendet werden. Weitere Informationen finden Sie unter Prozess-Seiten und Objekttypen.

Beim Aufruf der Script-Funktion ist immer ein Host und ein Pfad anzugeben. Diese Parameter können nur dann weggelassen werden, wenn GET_FILESYSTEM im Script schon einmal aufgerufen wurde. In diesem Fall bleibt der zurückgegebene Wert der gleiche wie beim letzten Aufruf.

:SET &NumberFiles# = GET_FILESYSTEM(WIN01, "C:\Temp", PATH_FILE_COUNT)
!mehrere Script-Zeilen
:SET &NumberFiles# = GET_FILESYSTEM(,, PATH_FILE_COUNT)
!mehrere Script-Zeilen
:SET &NumberFiles# = GET_FILESYSTEM(WIN01, "C:\Temp", PATH_FILE_COUNT)

Der erste Aufruf von GET_FILESYSTEM liefert die Anzahl der Dateien, die sich im Verzeichnis C:\Temp befinden (z. B. 50). Sollten jetzt Dateien in diesem Ordner gelöscht werden, liefert diese Script-Funktion immer noch den Wert 50. Der dritte Aufruf berechnet schließlich die Werte des Dateisystems neu und liefert eine reduzierte Anzahl von Dateien.

Plattformspezifische Informationen

Die folgenden Werte und Informationen zum Dateisystem gelten nur für bestimmte Plattformen.

OS/400
Geben Sie immer eine Bibliothek und eine Datei an, um gültige Dateisystemwerte zu erhalten.
z/OS
- PATH_SPACE_ALLOCATED - Der zugewiesene Festplattenspeicher in z/OS kann nicht abgerufen werden. Gibt den belegten Festplattenspeicher zurück.
- PATH_SPACE_USED - Verwendeter Festplattenspeicher
- PATH_SPACE_UNUSED - Ist immer NULL, da der Wert die Differenz zwischen PATH_SPACE_ALLOCATED und PATH_SPACE_USED ist.
Wenn ein GDG-Name angegeben wird, ruft die Script-Funktion folgende Dateisystemwerte ab: PATH_SPACE_USED und PATH_FILE_COUNT.
BS2000
Kann sich nur in BS2000, zugeordneter und verwendeter Speicherplatz unterscheiden. Es können beispielsweise 1000 PAM-Seiten reserviert werden. Der eigentliche Dateiinhalt kann jedoch immer noch nur 100 PAM-Seiten betragen.
Andere Betriebssysteme wie UNIX und VMS
- PATH_FILE_COUNT - Die Anzahl der Dateien.
- PATH_FOLDER_COUNT - Die Anzahl der Ordner.
- PATH_SPACE_USED - Summe der Dateigrößen im angegebenen Pfad.
- PATH_SPACE_TOTAL - Liefert dieselben Ergebnisse wie PATH_SPACE_USED und PATH_SPACE_ALLOCATED.

Beispiele

Im folgenden Beispiel wird die Script-Funktion GET_FILESYSTEM verwendet, um die Anzahl aller vorhandenen Dateien abzurufen und eine entsprechende Meldung zu senden. 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# Dateien stehen für die Verarbeitung zur Verfügung."

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 Aktivierungsreport 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 "Speicherkapazität des Laufwerks: &E1# MB"
: PRINT "Verwendeter Festplattenspeicher: &E2# MB"
: PRINT "Verfügbarer Speicher: &E3# MB"

Die folgende Beispiele zeigen die Verwendung der Script-Funktion mit GDG:

!Anzahl der Dateigenerierungen der Gruppe TEST.XXX
:SET &FILENAME# = GET_FILESYSTEM("MVSHOST", "TEST.XXX(*)", PATH_FILE_COUNT)

!Summe des von der aktuellen Generation verwenden Speicherplatzes
:SET &SPACE# = GET_FILESYSTEM("MVSHOST", "TEST.XXX(0)", PATH_SPACE_USED)

Siehe auch:

seealso

Script-Funktionen zur Ereignisbehandlung

Script-Elemente zur Fehlerbehandlung