Benutzerdefinierten StyleBooks erstellen und verwenden

February 5, 2024

Beitrag von:

Sie können ein eigenes StyleBook für Ihre Bereitstellung schreiben, es in Citrix Application Delivery Management (ADM) importieren und Konfigurationsobjekte erstellen. Sie können die API auch verwenden, um Konfigurationen aus Ihren StyleBooks zu erstellen.

Dieses Dokument enthält die folgenden Informationen:

Voraussetzungen

Bevor Sie mit der Erstellung von StyleBooks beginnen, stellen Sie sicher, dass Sie über folgende Kenntnisse verfügen:

NITRO API. Weitere Informationen finden Sie in der Nitro API-Dokumentation
YAML

StyleBook-Dateien verwenden das YAML-Format. Hinweise zum YAML-Format finden Sie unter YAML-Syntax.

Im Folgenden finden Sie eine Liste der YAML-Richtlinien, die Sie beim Erstellen von StyleBooks beachten müssen:

YAML unterscheidet zwischen Groß- und Klein
YAML erfordert eine korrekte Einrückung
Verwenden Sie die Taste <spacebar>, um eine korrekte Einrückung zu erstellen Verwenden Sie nicht die Taste <tab>. Die Verwendung der Taste <tab> führt zu einem Kompilierungsfehler beim Importieren Ihres StyleBook in MA
Verwenden Sie keine Zeichenfolgen in Anführungszeichen. Schließen Sie die Zeichenfolge nur dann in Anführungszeichen ein, wenn eine Zeichenfolge Satzzeichen (Bindestriche, Doppelpunkte usw.) enthält. Wenn Sie eine Zahl als String interpretieren möchten, fügen Sie die Zahl entweder in Anführungszeichen ein oder verwenden Sie die integrierte Funktion str () von StyleBooks.
Literale wie YES/Yes/yes/Y/y/NO/no/No/n/N, ON/On/on/OFF/Off/off und TRUE/true/truthy/FALSE/False/false/falsely werden als boolesch betrachtet und sind äquivalent zu true und false. Um sie als Zeichenfolgen zu interpretieren, setzen Sie sie in Anführungszeichen. Zum Beispiel:
- “JA”
- “Nein”
- “Stimmt”
- “Falsch” und so weiter.

Hinweis

Bevor Sie Ihre StyleBook-Datei in NetScaler ADM importieren, sollten Sie überprüfen, ob Ihre Datei mit dem YAML-Format kompatibel ist. Citrix empfiehlt, den integrierten YAML-Validator in StyleBooks zu verwenden, um den YAML-Inhalt zu validieren und zu importieren.

Während der Konfiguration von StyleBooks können Sie nur Nitro-Konfigurationsressourcen verwenden, die die Vorgänge zum Erstellen und Löschen (POST- und DELETE-HTTP-Methoden ) unterstützen. Weitere Informationen finden Sie in der Dokumentation zu Nitro-APIs.

Anatomie eines StyleBook

Das Schreiben von StyleBooks setzt voraus, dass Sie die Grammatik, Syntax und Struktur von StyleBooks verstehen. Ein typisches StyleBook hat die folgenden Abschnitte:

Kopfzeile: In diesem Abschnitt können Sie die Identität eines StyleBooks definieren und beschreiben, was es tut. Dies ist ein obligatorischer Abschnitt.
StyleBooks importieren: In diesem Abschnitt können Sie festlegen, auf welches andere StyleBook Sie aus Ihrem aktuellen StyleBook verweisen möchten. Das Importieren der NetScaler ADC NITRO-Konfiguration StyleBooks oder anderer StyleBooks ist erforderlich, um ein StyleBook zu schreiben. Dies ist ein obligatorischer Abschnitt.
Parameter: In diesem Abschnitt können Sie die Parameter definieren, die Sie in Ihrem StyleBook benötigen, um eine Konfiguration zu erstellen. Es beschreibt die Eingabe, die Ihr StyleBook nimmt. Dies ist ein optionaler Abschnitt.
Komponenten: In diesem Abschnitt können Sie die Entitäten (Konfigurationsobjekte) definieren, die vom StyleBook für eine bestimmte Konfiguration erstellt werden. Dieser Abschnitt wird als Kern eines StyleBook betrachtet. Komponenten verwenden in der Regel die im Parameterbereich bereitgestellten Eingaben, um die vom StyleBook generierte Konfiguration anzupassen. Dies ist ein optionaler Abschnitt.

Ein StyleBook kann einen Parameterabschnitt oder einen Komponentenbereich oder beides haben. Ein StyleBook, das nur den Parameterbereich enthält, ist nützlich, um eine Liste von Parametern zu definieren, die von anderen StyleBooks verwendet werden können. Dies fördert die Wiederverwendbarkeit von Parametergruppen über eine Reihe von StyleBooks hinweg. Ein StyleBook mit nur einem Komponentenabschnitt kann verwendet werden, wenn Sie die Werte für Attribute im StyleBook angeben möchten, anstatt Parameter für Benutzereingaben zu definieren.
Ausgaben: Während der Parameterbereich die Eingänge des StyleBook definiert, definiert dieser optionale Abschnitt seine Ausgaben. In diesem optionalen Ausgabeabschnitt können Sie die Komponenten angeben, die Sie Benutzern, die eine Konfiguration aus diesem StyleBook erstellen, und anderen StyleBooks, die dieses StyleBook importieren, zur Verfügung stellen möchten. Benutzer und importierende StyleBooks können dann auf die Eigenschaften der bereitgestellten Komponenten verweisen.
Operationen: Ein StyleBook kann einen optionalen Abschnitt enthalten, um Analytics in NetScaler ADM auf jedem virtuellen Server zu aktivieren, der Teil des StyleBook ist.

Die folgende Abbildung zeigt einen einfachen Überblick über ein StyleBook.

Lokalisierte Abbildung

Die folgenden Beispiele helfen Ihnen, die Grammatik und Struktur eines StyleBook zu kennenlernen und StyleBooks mit zunehmender Komplexität zu schreiben.

Die offizielle Version dieses Inhalts ist auf Englisch. Für den einfachen Einstieg wird Teil des Inhalts der Cloud Software Group Dokumentation maschinell übersetzt. Cloud Software Group hat keine Kontrolle über maschinell übersetzte Inhalte, die Fehler, Ungenauigkeiten oder eine ungeeignete Sprache enthalten können. Es wird keine Garantie, weder ausdrücklich noch stillschweigend, für die Genauigkeit, Zuverlässigkeit, Eignung oder Richtigkeit von Übersetzungen aus dem englischen Original in eine andere Sprache oder für die Konformität Ihres Cloud Software Group Produkts oder Ihres Diensts mit maschinell übersetzten Inhalten gegeben, und jegliche Garantie, die im Rahmen der anwendbaren Endbenutzer-Lizenzvereinbarung oder der Vertragsbedingungen oder einer anderen Vereinbarung mit Cloud Software Group gegeben wird, dass das Produkt oder den Dienst mit der Dokumentation übereinstimmt, gilt nicht in dem Umfang, in dem diese Dokumentation maschinell übersetzt wurde. Cloud Software Group kann nicht für Schäden oder Probleme verantwortlich gemacht werden, die durch die Verwendung maschinell übersetzter Inhalte entstehen können.

Benutzerdefinierten StyleBooks erstellen und verwenden

February 5, 2024

Beitrag von:

Benutzerdefinierten StyleBooks erstellen und verwenden

Voraussetzungen

Anatomie eines StyleBook

In diesem Artikel