Komponenten
Das Komponenten-Konstrukt in einem StyleBook gilt als der wichtigste Abschnitt im StyleBook. In diesem Abschnitt definieren Sie die zu erstellenden Konfigurationsobjekte. Mit diesem Konstrukt können Sie ein oder mehrere Konfigurationsobjekte desselben Typs erstellen.
Das Komponenten-Konstrukt kann die im Parameterabschnitt bereitgestellten Eingaben verwenden, um die vom StyleBook generierte Konfiguration anzupassen. Dies ist ein optionaler Abschnitt, obwohl die meisten StyleBooks einen Komponentenabschnitt haben.
Die folgende Tabelle beschreibt die Hauptattribute einer Komponente.
| Attribut | Beschreibung |
|---|---|
name |
Der Name der Komponente. Sie können einen alphanumerischen Namen angeben. Der Name muss mit einem Buchstaben beginnen und kann zusätzliche Buchstaben, Zahlen, Bindestriche (-) oder Unterstriche (_) enthalten. |
description |
Eine Beschreibung der Rolle dieser Komponente im StyleBook. |
type |
Der Typ bestimmt, welche Eigenschaften diese Komponente bereitstellt. Komponenten haben zwei Arten von Typen: Integrierter Typ: Dieser Typ wird vom System bereitgestellt und muss nicht von Ihnen definiert werden, zum Beispiel die NITRO-Entitätstypen lbvserver oder servicegroup. Wenn eine Komponente ein Attribut vom integrierten Typ hat, erstellt sie ein Konfigurationsobjekt dieses Typs auf dem NetScaler. Wenn eine Komponente beispielsweise auf den integrierten Typ lbvserver verweist, erstellt diese Komponente einen virtuellen Lastausgleichsserver auf der NetScaler-Instanz, die das Ziel der Konfiguration ist. Zusammengesetzter Typ: Dieser Typ verweist auf ein vorhandenes StyleBook, das Sie erstellt und in NetScaler Console importiert haben. Wenn eine Komponente ein Attribut vom zusammengesetzten Typ hat, erstellt sie alle Konfigurationsobjekte, die im referenzierten StyleBook angegeben sind, auf der NetScaler-Instanz, die das Ziel der Konfiguration ist. Dies ermöglicht es Ihnen, mehrere StyleBooks zu kombinieren, wobei jedes StyleBook einen Teil der endgültigen Konfiguration erstellt. Weitere Informationen zu zusammengesetzten StyleBooks finden Sie unter Erstellen eines zusammengesetzten StyleBooks. |
meta-properties |
Meta-Eigenschaften definieren die Aktionen, die für NetScaler-Objekte ausgeführt werden sollen. Sie können statische oder dynamische Werte als gültige Meta-Eigenschaftsaktion annehmen. Wenn Sie Ausdrücke für eine Meta-Eigenschaft angeben, wendet sie die gültigen Meta-Eigenschaftsaktionen für NetScaler-Objekte dynamisch an. Dieses Attribut kann in einem StyleBook verwendet werden, wenn Sie Nicht-CRUD-Operationen an NetScaler-Objekten durchführen möchten. Weitere Informationen finden Sie unter Erstellen eines StyleBooks zur Durchführung von Nicht-CRUD-Operationen. |
properties |
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. Bei einem integrierten Typ sind dies die Eigenschaften oder Attribute des entsprechenden NITRO-Objekts. Bei einer 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 die Version 10.5 bezieht, die Sie im Abschnitt „import-stylebooks“ angegeben haben, und lbvserver ist eine NITRO-Ressource in diesem Namespace.
Die Eigenschaften in diesem Abschnitt umfassen vier obligatorische und ein optionales Attribut (
lbmethod) der lbvserver Ressource und ermöglichen es Ihnen, Werte für diese Attribute anzugeben. 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 erhalten. Sie verweisen auf die im Abschnitt „parameters“ definierten Parameternamen, indem Sie die $parameters.\<name> Notation verwenden, zum Beispiel $parameters.ip.
Um mehr über alle verfügbaren NetScaler NITRO-Ressourcen und deren Attribute/Eigenschaften zu erfahren, lesen Sie die Dokumentation zur NetScaler NITRO REST API.
Hinweis
Sie müssen Kleinbuchstaben für die Attributnamen von NITRO-Ressourcentypen (ihre Komponenteneigenschaften) verwenden. Andernfalls schlägt der Import eines StyleBooks fehl.