Citrix Application Delivery Management Service

Parameter

In diesem Abschnitt können Sie alle Parameter definieren, die Sie in Ihrem StyleBook benötigen, um eine Konfiguration zu erstellen. Es beschreibt die Eingabe, die Ihr StyleBook nimmt. Obwohl dies ein optionaler Abschnitt ist, benötigen die meisten StyleBooks möglicherweise einen. Im Parameterabschnitt können Sie die Fragen definieren, die Benutzer beantworten sollen, wenn sie das StyleBook verwenden, um eine Konfiguration auf einer Citrix ADC Instanz zu erstellen.

Wenn Sie Ihr StyleBook in Citrix ADM importieren und es zum Erstellen einer Konfiguration verwenden, verwendet die GUI diesen Abschnitt des StyleBook, um ein Formular anzuzeigen, das Eingaben für Werte der von Ihnen definierten Parameter übernimmt.

Im folgenden Abschnitt werden die Attribute beschrieben, die Sie für jeden Parameter in diesem Abschnitt angeben müssen:

Name

Der Name des Parameters, den Sie definieren möchten. Sie können einen alphanumerischen Namen angeben.

Der Name muss mit einem Alphabet beginnen und kann zusätzliche Alphabete, Zahlen, Bindestrich (-) oder Unterstrich (_) enthalten.

Beachten Sie, dass Sie beim Schreiben eines StyleBook dieses Attribut name verwenden können, um auf den Parameter in anderen Abschnitten zu verweisen, indem Sie die Notation $parameters verwenden. <name>.

Obligatorisch? Ja

Bezeichnung

Eine Zeichenfolge, die in der ADM-GUI als Name dieses Parameters angezeigt wird.

Obligatorisch? Nein

Beschreibung

Eine Hilfe-Zeichenfolge, die beschreibt, wofür der Parameter verwendet wird. Die ADM-GUI zeigt diesen Text an, wenn der Benutzer auf das Hilfesymbol für diesen Parameter klickt.

Obligatorisch? Nein

Typ

Die Art des Wertes, den diese Parameter annehmen können. Parameter können von einem der folgenden integrierten Typen sein:

  • string: Ein Array von Zeichen. Wenn keine Länge angegeben wird, kann der Zeichenfolgenwert beliebig viele Zeichen annehmen. Sie können jedoch die Länge eines String-Typs einschränken, indem Sie die Attribute min-length und max-length verwenden.

  • Zahl: Eine ganzzahlige Zahl. Sie können die minimale und maximale Anzahl angeben, die dieser Typ annehmen kann, indem Sie die Attribute min-value und max-value verwenden.

  • boolean: Kann entweder wahr oder falsch sein. Beachten Sie auch, dass alle Literale von YAML als Booleans betrachtet werden (zum Beispiel Ja oder Nein).

  • ipaddress: Eine Zeichenfolge, die eine gültige IPv4- oder IPv6-Adresse darstellt.

  • tcp-port: Eine Zahl zwischen 0 und 65535, die einen TCP- oder UDP-Port darstellt.

  • password: Stellt einen undurchsichtigen/geheimen Zeichenfolgenwert dar. Wenn ADM-GUI einen Wert für diesen Parameter anzeigt, wird er als Sternchen (*****) angezeigt.

  • certfile: Stellt eine Zertifikatdatei dar. Auf diese Weise können Sie die Dateien direkt von Ihrem lokalen System hochladen, wenn Sie eine StyleBook-Konfiguration mit der ADM GUI erstellen. Die hochgeladene Zertifikatsdatei wird im Verzeichnis /var/mps/tenants/ <tenant_path> /ns_ssl_certs in ADM gespeichert.

    Die Zertifikatsdatei wird der Liste der Zertifikate hinzugefügt, die von ADM verwaltet werden.

  • keyfile: Stellt eine Zertifikatsschlüsseldatei dar. Auf diese Weise können Sie die Datei direkt von Ihrem lokalen System hochladen, wenn Sie eine StyleBook-Konfiguration mit der ADM-GUI erstellen. Die hochgeladene Zertifikatdatei wird im Verzeichnis /var/mps/tenants/ <tenant_path> /ns_ssl_keys in ADM gespeichert.

    Die Zertifikatschlüsseldatei wird der Liste der Zertifikatschlüssel hinzugefügt, die von ADM verwaltet werden.

  • file: Stellt eine Datei dar.

  • Objekt: Dieser Typ wird verwendet, wenn Sie mehrere verwandte Parameter unter einem übergeordneten Element gruppieren möchten. Sie müssen den übergeordneten Parameter den Typ als Objekt angeben. Ein Parameter vom Typ object kann einen verschachtelten Abschnitt parameter haben, um die darin enthaltenen Parameter zu beschreiben.

  • ein anderes StyleBook: Wenn Sie diesen Parametertyp verwenden, erwartet dieser Parameter, dass sein Wert in Form der Parameter ist, die im StyleBook definiert sind, der seinen Typ angibt.

Ein Parameter kann auch einen Typ haben, der eine Liste aller oben aufgeführten Typen ist, indem [] am Ende des Typs hinzugefügt wird. Wenn das type-Attribut beispielsweise string [] ist, nimmt dieser Parameter eine Liste von Zeichenfolgen als Eingabe an. Sie können eine, zwei oder mehrere Zeichenfolgen für diesen Parameter angeben, wenn Sie eine Konfiguration aus diesem StyleBook erstellen.

Obligatorisch? Ja

Netzwerk

Wenn Sie angeben type: ipaddress, können Sie das networkAttribut für die automatische Zuweisung von IP-Adresse aus einem ADM IPAM-Netzwerk angeben.

ADM weist automatisch eine IP-Adresse aus dem networkAttribut zu, wenn Sie eine StyleBook-Konfiguration erstellen.

Beispiel:

      name: virtual-ip
      label: "Load Balancer IP Address"
      type: ipaddress
      network: "network-1"
      required: true

In diesem Beispiel weist das virtual-ipFeld automatisch eine IP-Adresse aus. network-1Die IP-Adresse wird wieder an das Netzwerk freigegeben, wenn die Konfiguration gelöscht wird.

Schlüssel

Geben Sie true oder false an, um anzugeben, ob dieser Parameter ein Schlüsselparameter für das StyleBook ist.

Ein StyleBook kann nur einen Parameter als key -Parameter definiert haben.

Wenn Sie aus demselben StyleBook (auf derselben oder anderen ADC-Instanzen) unterschiedliche Konfigurationen erstellen, weist jede Konfiguration einen anderen/eindeutigen Wert für diesen Parameter auf.

Der Standardwert ist false.

Obligatorisch? Nein

erforderlich

Geben Sie true oder false an, um anzugeben, ob ein Parameter obligatorisch oder optional ist. Wenn es auf true gesetzt ist, ist der Parameter obligatorisch und der Benutzer muss beim Erstellen von Konfigurationen einen Wert für diesen Parameter angeben.

Die ADM-GUI zwingt den Benutzer, einen gültigen Wert für diesen Parameter anzugeben.

Der Standardwert ist false.

Obligatorisch? Nein

zulässige Werte

Verwenden Sie dieses Attribut, um eine Liste gültiger Werte für einen Parameter zu definieren, wenn der Typ auf string gesetzt ist.

Beim Erstellen einer Konfiguration über die ADM-GUI wird der Benutzer aufgefordert, einen Parameterwert aus dieser Liste auszuwählen.

Beispiel 1:

Name: IP-Adresse

Typ: string

zulässige Werte:

  • SOURCEIP
  • DEST IP
  • NONE

Beispiel 2:

name: TCP-Port

Typ: tcp-port

zulässige Werte:

  • 80
  • 81
  • 8080

Beispiel 3:

(Liste der tcp-ports, wobei jedes Element der Liste nur Werte in zulässigen Werten haben kann)

name: tcpports

Typ: tcp-port []

zulässige Werte:

  • 80
  • 81
  • 8080
  • 8081

Obligatorisch? Nein

Standard

Verwenden Sie dieses Attribut, um einem optionalen Parameter einen Standardwert zuzuweisen. Wenn ein Benutzer beim Erstellen einer Konfiguration keinen Wert angibt, wird der Standardwert verwendet.

Wenn ein Benutzer beim Erstellen der Konfiguration über die ADM-GUI keinen Wert für einen Parameter bereitstellt, der keinen Standardwert hat, wird für diesen Parameter kein Wert festgelegt.

Beispiel 1:

name: timeout

type: number

Def ault: 20

Beispiel 2:

(wobei der Standardwert des Parameters eine Liste von Werten ist):

name: Protokolle

type: string []

Standard:

  • TCP
  • UDP
  • IP

Beispiel 3:

name: timeout

type: number

default: 20

Beispiel 4:

name: tcpport

Typ: tcp-port

default: 20

Obligatorisch? Nein

Muster

Verwenden Sie dieses Attribut, um ein Muster (regulärer Ausdruck) für die gültigen Werte dieses Parameters zu definieren, wenn der Typ des Parameters string ist.

Beispiel:

name: appname

type: string

pattern: “[a-z]+”

Obligatorisch? Nein

min-value

Verwenden Sie dieses Attribut, um den Minimalwert für Parameter vom Typ number oder tcp-port zu definieren.

Beispiel:

name: audio-port

type: tcp-port

min-value: 5000

Der Min-Wert von Zahlen kann negativ sein, aber der Min-Wert für tcp-port sollte nicht negativ sein.

Obligatorisch? Nein

max-value

Mit diesem Attribut definieren Sie den Maximalwert für Parameter vom Typ number oder tcp-port.

Der Maximalwert sollte größer als der Minimalwert sein, falls definiert.

Beispiel:

name: audio-port

type: tcp-port

min-value: 5000

max-value: 15000

Obligatorisch? Nein

min-length

Verwenden Sie dieses Attribut, um die Mindestlänge der Werte zu definieren, die für einen Parameter vom Typ string akzeptiert werden.

Die Mindestlänge der Zeichen, die als Werte definiert sind, sollte größer oder gleich Null sein.

Beispiel:

name: appname

type: string

min-Länge: 3

Obligatorisch? Nein

max-length

Verwenden Sie dieses Attribut, um die maximale Länge der Werte zu definieren, die für einen Parameter vom Typ string akzeptiert werden.

Die maximale Länge der Werte sollte größer oder gleich der Länge der in min-length definierten Zeichen sein.

Beispiel:

name: appname

type: string

max-length: 64

Obligatorisch? Nein

min-items

Verwenden Sie dieses Attribut, um die minimale Anzahl von Elementen in einem Parameter zu definieren, der eine Liste ist.

Die Mindestanzahl von Elementen sollte größer oder gleich Null sein.

Beispiel:

name: server-ips

type: ipaddress[]

min-items: 2

Obligatorisch? Nein

max-items

Verwenden Sie dieses Attribut, um die maximale Anzahl von Elementen in einem Parameter zu definieren, der eine Liste ist.

Die maximale Anzahl von Elementen sollte größer sein als die minimale Anzahl von Elementen, wenn sie definiert sind.

Beispiel:

name: server-ips

type: ipaddress[]

min-items: 2

max-items: 250

Obligatorisch? Nein

GUI

Verwenden Sie dieses Attribut, um das Layout des Parameters in der ADM-GUI anzupassen.

Obligatorisch? Nein

Spalten

Dies ist ein Unterattribut des GUI-Attributs. Verwenden Sie dieses Attribut, um die Anzahl der Spalten zu definieren, die die type: object[]Parameter in der ADM-GUI anzeigen.

Obligatorisch? Nein

updatable

Dies ist ein Unterattribut des GUI-Attributs. Verwenden Sie dieses Attribut, um anzugeben, ob der Parameter nach dem Erstellen der Konfiguration aktualisiert werden kann. Legen Sie dieses Attribut nur für einfache Parametertypen wie String, Boolean oder Zahl fest.

Wenn der Wert auf gesetzt ist false, wird das Parameterfeld beim Aktualisieren der Konfiguration ausgegraut.

Obligatorisch? Nein

collapse_pane

Dies ist ein Unterattribut des GUI-Attributs. Verwenden Sie diese Option, um anzugeben, ob der Bereich, der das Layout dieses Objektparameters definiert, ausgeblendet werden kann.

Wenn der Wert auf true gesetzt ist, kann der Benutzer die untergeordneten Parameter unter diesem übergeordneten Parameter erweitern oder reduzieren.

Beispiel:

gui:

 collapse_pane: true

 columns: 2

Beispiel für einen vollständigen Parameterabschnitt:


parameters:

   -

      name: name

      label: Name

      description: Name of the application

      type: string

      required: true

   -

      name: ip

      label: IP Address

      description: The virtual IP address used for this application

      type: ipaddress

      required: true

   -

      name: svc-servers

      label: Servers

      type: object[]

      required: true

      parameters:

        -

              name: svc-ip

              label: Server IP

              description: The IP address of the server

              type: ipaddress

              required: true

        -

              name: svc-port

              label: Server Port

              description: The TCP port of the server

              type: tcp-port

              default: 80

        -

              name: lb-alg

              label: LoadBalancing Algorithm

              type: string

              allowed-values:

                 - ROUNDROBIN

                 - LEASTCONNECTION

              default: ROUNDROBIN

        -

              name: enable-healthcheck

              label: Enable HealthCheck?

              type: boolean

              default: true

Im Folgenden finden Sie ein Beispiel, das alle Attribute einer Liste und die in früheren Abschnitten erläuterten Werte definiert:


        -
              name: features-list

              type: string[]

              min-length: 1

              max-length: 3

              min-items: 1

              max-items: 3

              pattern: "[A-Z]+"

              allowed-values:

                - SP

                - LB

                - CS

              default:

                - LB

Parameter