Komponenten

Das Komponentenkonstrukt in einem StyleBook gilt als der wichtigste Abschnitt im StyleBook. In diesem Abschnitt definieren Sie die Konfigurationsobjekte, die erstellt werden müssen. Mit diesem Konstrukt können Sie ein oder mehrere Konfigurationsobjekte desselben Typs erstellen.

Das Komponentenkonstrukt kann die Eingabe im Parameterbereich verwenden, um die vom StyleBook generierte Konfiguration anzupassen. Dies ist ein optionaler Abschnitt, obwohl die meisten StyleBooks einen Komponentenabschnitt haben.

In der folgenden Tabelle werden die wichtigsten Attribute einer Komponente beschrieben.

Attribut Beschreibung
Name Der Name der Komponente. Sie können einen alphanumerischen Namen angeben. Der Name muss mit einem Alphabet beginnen und kann zusätzliche Alphabete, Zahlen, Bindestrich (-) oder Unterstrich (_) enthalten.
Beschreibung Eine Beschreibung der Rolle dieser Komponente im StyleBook.
Typ Der Typ bestimmt, welche Eigenschaften diese Komponente bietet. Komponenten haben zwei Arten von Typen: Built-in Typ: Dieser Typ wird vom System bereitgestellt und Sie müssen ihn nicht definieren, zum Beispiel die NITRO -Entitätstypen lbvserver oder servicegroup. Wenn eine Komponente über ein integriertes Typattribut verfügt, erstellt sie ein Konfigurationsobjekt dieses Typs auf dem Citrix ADC. Wenn sich beispielsweise eine Komponente auf den integrierten Typ lbvserver bezieht, erstellt diese Komponente einen virtuellen Lastausgleichsserver auf der Citrix ADC Instanz, der das Ziel der Konfiguration ist. Zusammengesetzter Typ: Dieser Typ bezieht sich auf ein vorhandenes StyleBook, das Sie erstellt und in Citrix Application Delivery Management (ADM) importiert haben. Wenn eine Komponente über ein zusammengesetztes Typattribut verfügt, erstellt sie alle Konfigurationsobjekte, die im referenzierten StyleBook angegeben sind, auf der Citrix ADC Instanz, die das Ziel der Konfiguration ist. Auf diese Weise können Sie mehrere StyleBooks kombinieren, in denen jedes StyleBook einen Teil der endgültigen Konfiguration erstellt. Weitere Hinweise zu zusammengesetzten StyleBooks finden Sie unterErstellen eines zusammengesetzten StyleBook.
-Eigenschaften Die Unterattribute, die für ein Komponententypattribut verwendet werden können. Die Eigenschaften, die für eine Komponente gültig sind, werden durch ihren Typ bestimmt. Für einen integrierten Typ sind dies die Eigenschaften oder Attribute des entsprechenden Nitro-Objekts. Für eine Komponente, deren Typ ein anderes StyleBook ist, d. h. ein zusammengesetzter Typ, entsprechen die Eigenschaften den in diesem StyleBook definierten Parametern.

Beispiel:


components:

   -

     name: my-lbvserver-comp

     type: ns::lbvserver

     properties:

        name: $parameters.name

        servicetype: HTTP

        ipv46: $parameters.ip

        port: 80

        lbmethod: $parameters.lb-alg

In diesem Beispiel haben Sie eine Komponente namens my-lbvserver-comp definiert. Diese Komponente ist vom Typ ns::lbvserver (ein integrierter Typ), wobei ns das Präfix ist, das sich auf den Namespace netscaler.nitro.config und Version 10.5 bezieht, den Sie im Abschnitt import-stylebooks angegeben hatten, und lbvserver ist eine NITRO -Ressource in diesem Namespace.

Die Eigenschaften in diesem Abschnitt umfassen vier obligatorische und ein optionales Attribut (lbmethod) der Ressource lbvserver und können Sie Werte für diese Attribute angeben. In diesem Beispiel geben Sie statische Werte für servicetype und port an, während die Eigenschaften name, ipv46 und lbmethod ihre Werte aus den Eingabeparametern abrufen. Sie verweisen auf die Parameternamen, die im Parameterabschnitt definiert sind, indem Sie $parameters verwenden. <name>Notation, zum Beispiel $parameters.ip.

Weitere Informationen zu allen verfügbaren Citrix ADC NITRO -Ressourcen und deren Attribute/Eigenschaften finden Sie in derCitrix ADC NITRO REST-APIDokumentation.

Hinweis:

Sie müssen Kleinbuchstaben für die Attributnamen von NITRO -Ressourcentypen (deren Komponenteneigenschaften) verwenden. Andernfalls schlägt der Import eines StyleBook fehl.

Komponenten