CLI-Configlets-Workflow

Ein CLI-Configlet kann im Arbeitsbereich CLI-Configlets definiert werden. Tabelle 1 listet die Parameter auf, die für ein CLI-Configlet definiert werden müssen.

Tabelle 1: Parameter für ein CLI-Configlet
Parameter	Beschreibung
Namen	Name des CLI-Configlets. Der Name darf nicht länger als 255 Zeichen sein. Zu den zulässigen Zeichen gehören der Bindestrich (-), der Unterstrich (_), Buchstaben und Zahlen sowie der Punkt (.). Es ist nicht möglich, zwei Configlets mit demselben Namen zu verwenden.
Kategorie	Kategorie des CLI-Configlets. Die Kategorie darf 255 Zeichen nicht überschreiten. Zu den zulässigen Zeichen gehören der Bindestrich (-), der Unterstrich (_), Buchstaben und Zahlen sowie der Punkt (.).
Gerätefamilien-Serie	Gerätefamilienserie, für die das CLI-Configlet anwendbar ist.
Kontext	Kontext, für den das CLI-Configlet anwendbar ist. Dies ist ein optionales Feld.
Beschreibung	Beschreibung des CLI-Configlets. Die Beschreibung darf nicht länger als 2500 Zeichen sein. Dies ist ein optionales Feld.
Vorschau-Optionen	Wenn Sie die Option Parameter anzeigen auswählen, werden die Parameter angezeigt, die im CLI-Configlet vorhanden sind. Die Option "Konfiguration anzeigen" zeigt die konsolidierte Konfiguration an, bevor das CLI-Configlet angewendet wird.
Optionen für die Nachbearbeitung	Wenn Sie die Option Parameter anzeigen auswählen, werden die Parameter angezeigt, die im CLI-Configlet vorhanden sind. Die Option "Konfiguration anzeigen" zeigt die konsolidierte Konfiguration an, nachdem das CLI-Configlet angewendet wurde.
Configlet-Inhalt	Das eigentliche CLI Configlet wird hier definiert. Das CLI-Configlet kann mehrere Seiten enthalten und folgt einer tabulatorartigen Struktur. Die Konfiguration, die auf das Gerät angewendet wird, kann auf mehrere Seiten aufgeteilt werden. Wenn die Konfiguration angewendet wird, werden alle Seiten in der Reihenfolge der Seitenzahlen kombiniert und in einem einzigen Commit-Vorgang auf das Gerät angewendet. Sie müssen das CLI-Configlet immer validieren, bevor Sie zur nächsten Seite wechseln.
Referenznummer	Der Wertebereich reicht von 1 bis 2¹⁶.

Hinweis:

Sie können nicht zur nächsten Seite wechseln, wenn der Inhalt des CLI-Configlets ungültig ist. Die Validierung umfasst den Abgleich von Klammern.

Parameter sind im CLI-Configlet definierte Variablen, deren Werte entweder aus der Umgebung abgerufen oder vom Benutzer während der Ausführung eingegeben werden. Wenn der Benutzer CLI-Configlets anwendet, wird er aufgefordert, Werte für alle im CLI-Configlet definierten Variablen einzugeben.

Um einen Parameter zu konfigurieren, klicken Sie auf das Symbol "Ändern" in der Symbolleiste. Die Seite "Edit Configlet Parameter" wird angezeigt. Verwenden Sie diese Seite, um die Attribute eines Parameters festzulegen.

Um einen zusätzlichen Parameter hinzuzufügen, klicken Sie auf das Symbol "Hinzufügen" in der Symbolleiste. Die Seite Add Configlet Parameter (Konfigurationsparameter hinzufügen) wird angezeigt. Die Attribute eines Parameters werden auf dieser Seite festgelegt.

Um einen Parameter zu löschen, klicken Sie auf das Löschen-Symbol in der Symbolleiste. Standardmäßig werden alle Variablen, die im CLI-Configlet vorhanden sind, auf der Seite "Parameter" aufgelistet. Lokale Variablen müssen manuell gelöscht oder auf den Typ "Unsichtbar" gesetzt werden.

In Tabelle 2 sind die Attribute der CLI-Configlet-Parameter aufgeführt.

Tabelle 2: Attribute der CLI-Configlet-Parameter
CLI-Configlet-Parameterattribute	Beschreibung
Parameter	Name des Parameters Wenn dieser Parameter mit einem Namensraum im `<configlet name>.<parameter.name>` Format angezeigt wird, gehört er zum mitgelieferten CLI-Configlet.
Anzeigename	Anzeigename des Parameters
Beschreibung	Beschreibung des Parameters
Typen	Folgende Parametertypen werden unterstützt: `Text field` – Sie können beim Ausführen des CLI-Configlets einen benutzerdefinierten Wert angeben. Der Standardwert für dieses Feld kann mit einem XPath im Feld "Xpath für konfigurierten Wert" oder mit einer einfachen Zeichenfolge im Feld "Standardwert" konfiguriert werden. Dies gibt einen einzelnen Wert zurück. `Selection field` – Sie können einen Wert aus einer Reihe von Optionen auswählen, wenn Sie dieses CLI-Configlet ausführen. Der Standardwert für dieses Feld kann mit einem XPath im Feld "Xpath für konfigurierten Wert" oder mit einer einfachen Zeichenfolge im Feld "Standardwert" konfiguriert werden. Die Optionen können durch einen XPath im Feld "Xpath für Auswahlwerte" oder durch Verwendung eines CSV-Strings im Feld "Auswahlwerte" konfiguriert werden. Dies gibt einen einzelnen Wert zurück. Hinweis: Obwohl dies einen einzelnen Wert zurückgibt, ist der Rückgabewert vom Typ Array, und der ausgewählte Wert kann aus Index 0 entnommen werden. `Invisible field` – Sie können dieses Feld nicht bearbeiten. Dieser Parameter bezieht sich auf Werte, die explizit als CSV-Zeichenfolge im Feld "Standardwert" oder durch einen XPath im Feld "Xpath für konfigurierten Wert" definiert sind. Dieses Feld gibt ein Array von Werten zurück. `Password field` – Sie müssen einen Wert eingeben, wenn Sie ein CLI-Configlet anwenden, das den Parameter enthält. Dadurch werden vertrauliche Informationen in den Auftragsergebnissen des Auftrags "CLI-Konfiguration anwenden" ausgeblendet. `Password Confirm field` – Sie müssen einen Wert zweimal eingeben, wenn Sie ein CLI-Configlet anwenden, das den Parameter enthält. Dadurch werden vertrauliche Informationen in den Auftragsergebnissen des Auftrags "CLI-Konfiguration anwenden" ausgeblendet.
Konfigurierter Wert XPath	Dieses Feld wird verwendet, um den XPath der konfigurierten Werte anzugeben. Das Verhalten dieses Feldes hängt vom Typ des Parameters ab. Wenn es sich bei dem Parametertyp um ein Textfeld oder ein Auswahlfeld handelt, wird der entsprechende Wert im XPath als Standardwert verwendet. Dieser Wert kann geändert werden. Wenn der XPath mehrere Werte zurückgibt, wird der erste zurückgegebene Wert berücksichtigt. Wenn es sich bei dem Parametertyp um ein unsichtbares Feld handelt, wird die Liste der vom XPath zurückgegebenen Werte als Wert des Parameters verwendet. Für das unsichtbare Feld sind nur dann der Wert XPath und der Auswahlwert XPath konfiguriert, wenn der Parameterbereich entweder geräte- oder entitätsspezifisch ist. Dies ist deaktiviert, wenn der Bereich global ist. Hinweis: Wenn Sie $INTERFACE, $UNIT, Konfigurierter Wert Xpath-Feld, Unsichtbares Feld und Auswahlfeld verwenden, sollte die Variablendefinition im Configlet-Editor enthalten `.get(0)` , um den Wert aus dem Array abzurufen. Beispiel: $INTERFACE.get(0).
Standardwert	Zeigt das gleiche Verhalten wie das Xpath-Feld "Konfigurierter Wert" an, mit der Ausnahme, dass der Wert explizit angegeben wird. Dieses Feld wird nur berücksichtigt, wenn der konfigurierte Wert XPath nicht angegeben ist oder wenn der XPath keinen Wert zurückgibt.
Auswahlwerte XPath	Dieses Feld ist nur aktiviert, wenn der Parametertyp ein Auswahlfeld ist. Dieses Feld enthält den XPath (mit Bezug auf die Geräte-XML), um den Satz von Werten für das Auswahlfeld abzurufen.
Selektionswerte	Dieses Feld ist identisch mit dem XPath-Feld "Auswahlwerte", mit der Ausnahme, dass der Wert explizit angegeben wird. Dieses Feld wird nur berücksichtigt, wenn die Auswahlwerte XPath nicht angegeben sind oder wenn der XPath keinen Wert zurückgibt. Hinweis: Durch Trennzeichen getrennte Werte können verwendet werden, um ein Array von Werten in den Feldern Standardwert und Auswahlwerte bereitzustellen. Hinweis: Beim Definieren des XPath müssen Sie mit der `text ()` Funktion direkt auf den Text-Node zugreifen. Andernfalls wird der vollständige XML-Pfad des Knotens zurückgegeben. Beispiel: / device/interface-information/physical-interface/name/text(), um die Namen aller Schnittstellen abzurufen.
Bestellung	Reihenfolge des Parameters. Dies ist die relative Reihenfolge, in der das Feld zum Zeitpunkt der Ausführung für Benutzereingaben angezeigt werden muss.
Regex-Wert	Dieses Feld enthält reguläre Ausdrücke für den Parameter, der verwendet wird, um den Parameterwert zu validieren, während Sie das CLI-Configlet auf das Gerät anwenden.
Schreibgeschützt	Gibt an, ob der Parameter zum Basis-Configlet oder zum mitgelieferten Configlet gehört: false – Dieser Parameter gehört zum Basis-Configlet. true – Dieser Parameter gehört zum mitgelieferten Configlet. Der Parameter kann in diesem Configlet nicht geändert oder gelöscht werden.

CLI-Configlets-Workflow

Zugehörige Dokumentation