Citrix Application Delivery Management Service

Erstellen und Verwenden von benutzerdefinierten StyleBooks

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 auch API verwenden, um Konfigurationen aus Ihren StyleBooks zu erstellen.

Dieses Dokument enthält die folgenden Informationen:

Bevor Sie beginnen

Bevor Sie mit der Erstellung von StyleBooks beginnen, stellen Sie sicher, dass Sie Folgendes kennen:

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

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

  • YAML unterscheidet Groß- und Kleinschreibung.
  • YAML erfordert korrekte Einrückung
  • Verwenden Sie die<spacebar> Taste, um eine korrekte Einrückung zu erstellen. Verwenden Sie keinen<tab> Schlüssel. Die Verwendung von<tab> Schlüssel erzeugt Kompilierungsfehler beim Importieren Ihres StyleBook in MA Service.
  • Verwenden Sie keine Zeichenfolgen in Anführungszeichen. Fügen Sie die Zeichenfolge nur 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 entweder die Zahl in Anführungszeichen ein oder verwenden Sie die str() integrierte Funktion von StyleBooks.
  • Literals like YES/Yes/yes/Y/y/NO/no/No/n/N, ON/On/on/OFF/Off/off, and TRUE/true/truthy/FALSE/False/false/falsely are considered Booleans, and are equivalent to true and false respectively. Um sie als Zeichenfolgen zu interpretieren, schließen Sie sie in Anführungszeichen ein. Beispiel:

    • JA
    • Nein
    • Richtig
    • Falsch und so weiter.

Hinweis:

Bevor Sie Ihre StyleBook-Datei in Citrix 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 unter Nitro APIs Dokumentation.

Anatomie eines StyleBook

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

  • Header: In diesem Abschnitt können Sie die Identität eines StyleBook 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 von Citrix ADC NITRO-Konfigurationsstylebooks oder anderen 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 Eingabe im Parameterbereich zur Anpassung der vom StyleBook generierten Konfiguration. Dies ist ein optionaler Abschnitt.
    Ein StyleBook kann über einen Parameterabschnitt oder einen Komponentenabschnitt oder beides verfügen. Ein StyleBook mit nur dem Parameterbereich 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 in einer Reihe von StyleBooks. 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 Parameter-Abschnitt die Eingaben des StyleBook definiert, definiert dieser optionale Abschnitt seine Ausgaben. In diesem optionalen Ausgabenabschnitt können Sie die Komponenten angeben, die Benutzern zur Verfügung gestellt werden sollen, die eine Konfiguration aus diesem StyleBook erstellen, und anderen StyleBooks, die dieses StyleBook importieren. Benutzer und das Importieren von StyleBooks können dann auf die Eigenschaften der exponierten Komponenten verweisen.
  • Vorgänge: Ein StyleBook kann einen optionalen Abschnitt enthalten, um Analytics in Citrix ADM auf jedem virtuellen Server zu aktivieren, der Teil des StyleBook ist.

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

lokalisiertes Bild

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

Erstellen und Verwenden von benutzerdefinierten StyleBooks