Die Nutzung der Workflows wird vorbereitet
Änderungen vorschlagen
PDFs
Sie sollten sich mit der Struktur und dem Format der Workflows vertraut machen, bevor Sie sie bei einer Live-ONTAP-Implementierung verwenden.
|
Sie sollten sicherstellen, dass Ihre ONTAP-Version alle API-Aufrufe in den Workflows unterstützt, die Sie verwenden möchten. Siehe "API-Referenz" Finden Sie weitere Informationen. |
Einführung
Ein Workflow ist eine Sequenz aus einem oder mehreren Schritten, die zum Erreichen einer bestimmten administrativen Aufgabe oder eines bestimmten Ziels erforderlich sind. Die ONTAP Workflows beinhalten die wichtigsten Schritte und Parameter, die Sie für jede Aufgabe benötigen. Sie dienen als Ausgangspunkt für die Anpassung Ihrer ONTAP Automatisierungsumgebung.
Jeder Schritt in einem ONTAP Workflow besteht aus einem der folgenden Typen:
-
REST-API-Aufruf (mit Details wie Curl- und JSON-Beispiele)
-
Einen anderen ONTAP-Workflow ausführen oder aufrufen
-
Verschiedene verwandte Aufgaben (z. B. eine Konfigurationsentscheidung)
Die meisten Workflow-Schritte sind REST-API-Aufrufe. Bei diesen Schritten wird ein gängiges Format verwendet, das ein Beispiel für eine Wellung und andere Informationen enthält. Siehe "API-Referenz" Weitere Informationen zu den REST-API-Aufrufen.
Ein Workflow kann nur einen Schritt enthalten. Diese einstufigen Workflows werden leicht anders formatiert als Workflows, die mehrere Schritte enthalten. Beispielsweise wird der explizite Schrittname entfernt. Die Aktion oder der Vorgang sollte aufgrund des Workflow-Titels eindeutig sein.
Eingabevariablen
Die Workflows sind so allgemein wie möglich ausgelegt, sodass sie in jeder ONTAP Umgebung eingesetzt werden können. Vor diesem Hintergrund verwenden die REST-API-Aufrufe Variablen in den Curl-Beispielen und andere Eingaben. Die REST-API-Aufrufe können dann problemlos an verschiedene ONTAP-Umgebungen angepasst werden.
Basis-URL-Format
Sie können die ONTAP-REST-API direkt über Curl oder eine Programmiersprache aufrufen. In diesem Fall unterscheidet sich die Basis-URL von der URL, die Sie für den Zugriff auf die ONTAP Online-Dokumentation oder den System Manager verwenden.
Wenn Sie direkt auf die API zugreifen, müssen Sie API an die Domain oder IP-Adresse anhängen. Beispiel:
Siehe "So erhalten Sie Zugriff auf die ONTAP REST API" Finden Sie weitere Informationen.
Allgemeine Eingabeparameter
Es gibt mehrere Eingabeparameter, die häufig bei den meisten REST-API-Aufrufen verwendet werden. Diese Parameter werden in der Regel nicht in den einzelnen Workflows beschrieben. Sie sollten mit den Parametern vertraut sein. Siehe "Eingabevariablen, die eine API-Anforderung steuern" Finden Sie weitere Informationen.
Wenn für einen bestimmten REST API-Aufruf zusätzliche Parameter benötigt werden, sind diese im Abschnitt zusätzliche Eingabeparameter für das Curl-Beispiel für jeden Workflow enthalten.
Variablenformat
Die ID-Werte und andere Variablen, die mit den Workflow-Beispielen verwendet werden, sind undurchsichtig und können mit jedem ONTAP-Cluster variieren. Um die Lesbarkeit der Beispiele zu verbessern, werden keine Istwerte verwendet. Variablen werden stattdessen verwendet. Dieser Ansatz basiert auf einem konsistenten Format und einem Satz reservierter Namen und bietet mehrere Vorteile, darunter:
-
Die Locken- und JSON-Proben sind besser lesbar und leichter zu verstehen.
-
Da alle Schlüsselwörter das gleiche Format verwenden, können Sie sie schnell identifizieren.
-
Es gibt keine Sicherheitsgefährdung, da die Werte nicht kopiert und wiederverwendet werden können.
Die Variablen sind so formatiert, dass sie in einer Bash Shell-Umgebung verwendet werden. Jede Variable beginnt mit einem Dollarzeichen und ist bei Bedarf in doppelte Anführungszeichen eingeschlossen. Dies macht sie für Bash erkennbar. Für die Namen wird immer Großbuchstaben verwendet.
Hier sind einige der häufigsten Variablen Schlüsselwörter. Diese Liste ist nicht erschöpfend und es werden bei Bedarf zusätzliche Variablen verwendet. Ihre Bedeutung sollte auf der Grundlage des Kontexts offensichtlich sein.
| Stichwort | Typ | Beschreibung |
|---|---|---|
FQDN_IP-DOLLAR |
URL |
Der vollständig qualifizierte Domain-Name oder die IP-Adresse der ONTAP Management LIF. |
„CLUSTER_ID“ |
Pfad |
Der UUIDv4-Wert, der den ONTAP-Cluster identifiziert, auf dem die API-Vorgänge ausgeführt werden. |
BASIC_AUTH |
Kopfzeile |
Die Zeichenfolge für die Anmeldeinformationen, die für die grundlegende HTTP-Authentifizierung verwendet wird. |
Beispiele für JSON-Eingaben
Einige REST-API-Aufrufe, z. B. die, die POST oder PATCH verwenden, erfordern JSON-Eingaben im Körper der Anforderung. Zur Übersichtlichkeit werden die JSON-Eingabebeispiele getrennt von den Curl-Beispielen dargestellt. Sie können die JSON-Eingabebeispiele mit einer der unten beschriebenen Techniken verwenden.
Sie können das JSON-Eingabebeispiel in eine Datei kopieren und lokal speichern. Der Curl-Befehl bezieht sich auf die Datei, die den verwendet --data Parameter mit dem Wert, der den Dateinamen mit einem angibt @ Präfix.
Zuerst müssen Sie das Beispiel für die Wellung kopieren und in eine Klemmenschale einfügen. Bearbeiten Sie dann das Beispiel, um den vollständig zu entfernen --data Am Ende des Parameters und ersetzen Sie ihn durch --data-raw Parameter. Kopieren Sie schließlich das JSON-Beispiel, und fügen Sie es ein, so dass es dem Curl-Befehl mit dem aktualisierten Parameter folgt. Sie sollten einfache Anführungszeichen verwenden, um das JSON-Eingabebeispiel zu umschließen.
Authentifizierungsoptionen
Die primäre für die REST-API verfügbare Authentifizierungsmethode ist die HTTP-Basisauthentifizierung. Ab ONTAP 9.14 haben Sie zudem die Möglichkeit, das Open Authorization (OAuth 2.0)-Framework mit Token-basierter Authentifizierung und Autorisierung zu verwenden.
HTTP-Basisauthentifizierung
Bei der Verwendung der grundlegenden Authentifizierung müssen die Benutzeranmeldeinformationen in jede HTTP-Anforderung einbezogen werden. Es gibt zwei Optionen zum Senden der Anmeldeinformationen.
Sie können den Autorisierungskopf manuell erstellen und in die HTTP-Anforderungen einbeziehen. Dies ist möglich, wenn Sie einen Curl-Befehl in der CLI oder eine Programmiersprache mit Ihrem Automatisierungscode verwenden. Zu den grundlegenden Schritten gehören:
-
Verketten Sie die Benutzer- und Kennwortwerte mit einem Doppelpunkt:
admin:david123 -
Konvertieren Sie den gesamten String in base64:
YWRtaW46ZGF2aWQxMjM= -
Erstellen Sie den Anforderungskopf:
Authorization: Basic YWRtaW46ZGF2aWQxMjM=
Die Workflow-Curl-Beispiele enthalten diesen Header mit der Variablen €BASIC_AUTH, die Sie vor der Verwendung aktualisieren müssen.
Eine weitere Option bei der Verwendung von Curl ist, den Autorisierungskopf zu entfernen und stattdessen den Curl user-Parameter zu verwenden. Beispiel:
--user username:password
Sie müssen die entsprechenden Anmeldedaten für Ihre Umgebung ersetzen. Die Anmeldeinformationen sind in base64 nicht kodiert. Wenn Sie den Befehl curl mit diesem Parameter ausführen, wird der String codiert und der Autorisierungskopf für Sie generiert.
OAuth 2.0
Wenn Sie OAuth 2.0 verwenden, müssen Sie ein Zugriffstoken von einem externen Autorisierungsserver anfordern und diese bei jeder HTTP-Anforderung einschließen. Im Folgenden werden die grundlegenden übergeordneten Schritte beschrieben. Siehe auch "Überblick über die Implementierung von ONTAP OAuth 2.0" Weitere Informationen zu OAuth 2.0 und zur Verwendung mit ONTAP.
Bevor Sie die REST-API für den Zugriff auf ONTAP verwenden, müssen Sie die ONTAP-Umgebung vorbereiten und konfigurieren. Im allgemeinen sind die Schritte:
-
ONTAP geschützte Ressourcen und Clients ermitteln
-
Prüfen Sie die vorhandene ONTAP-REST-Rolle und Benutzerdefinitionen
-
Installieren und Konfigurieren des Autorisierungsservers
-
Entwerfen und Konfigurieren der Client-Autorisierungsdefinitionen
-
Konfigurieren Sie ONTAP, und aktivieren Sie OAuth 2.0
Mit ONTAP und dem definierten und aktiven Autorisierungsserver können Sie einen REST-API-Aufruf mit einem OAuth 2.0-Token erstellen. Der erste Schritt besteht darin, ein Zugriffstoken vom Autorisierungsserver anzufordern. Dies geschieht außerhalb von ONTAP mit einer von mehreren verschiedenen Techniken auf der Grundlage des Servers. ONTAP gibt keine Zugriffstoken aus und führt keine Umleitung durch.
Nachdem Sie ein Zugriffstoken erhalten haben, können Sie einen Autorisierungs-Header erstellen und ihn mit den HTTP-Anforderungen integrieren. Unabhängig davon, ob Sie Curl oder eine Programmiersprache für den Zugriff auf die REST-API verwenden, müssen Sie den Header bei jeder Client-Anforderung einschließen. Sie können die Kopfzeile wie folgt erstellen:
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSld …
Verwenden der Beispiele mit Bash
Wenn Sie die Workflow-Curl-Beispiele direkt verwenden, müssen Sie die darin enthaltenen Variablen mit Werten aktualisieren, die für Ihre Umgebung geeignet sind. Sie können die Beispiele manuell bearbeiten oder sich darauf verlassen, dass die Bash-Shell die Ersetzung für Sie wie unten beschrieben durchsetzt.
|
Ein Vorteil der Verwendung von Bash ist, dass Sie die Variablenwerte einmal in einer Shell-Sitzung anstatt einmal pro Curl-Befehl einstellen können. |
-
Öffnen Sie die Bash Shell, die mit Linux oder einem ähnlichen Betriebssystem geliefert wird.
-
Legen Sie die Variablenwerte fest, die in dem zu laufenden Curl-Beispiel enthalten sind. Beispiel:
CLUSTER_ID=ce559b75-4145-11ee-b51a-005056aee9fb -
Kopieren Sie das Beispiel für die Wellung von der Workflow-Seite, und fügen Sie es in das Shell-Terminal ein.
-
Drücken Sie ENTER, um Folgendes zu tun:
-
Ersetzen Sie die von Ihnen festgelegten Variablenwerte
-
Führen Sie den Befehl curl aus
-