Produktdokumentation
Citrix Application Delivery Management
Current Release 13.0 12.1
PDF anzeigen

Parameter

July 1, 2020
Beigesteuert von: 
C

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 Citrix 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 Zertifikatdatei 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 Citrix ADM GUI erstellen. Die hochgeladene Zertifikatdatei wird im Verzeichnis /var/mps/tenants/<tenant_path>/ns_ssl_keys in Citrix ADM gespeichert.

    Die Zertifikatschlüsseldatei wird der Liste der Zertifikatschlüssel hinzugefügt, die von Citrix 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

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 Citrix 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. Ein Benutzer muss einen Wert für einen obligatorischen Parameter angeben, um eine Konfiguration zu erstellen, es sei denn, ein Standardwert ist definiert.

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

Der Standardwert ist false.

Obligatorisch? Nein

Hinweis

Wenn ein Parameter type: objectund hat required: false, werden die Unterparameter dieses Parameters nicht ausgewertet.

Wenn Sie möchten, dass der Standardwert der Unterparameter wirksam wird, setzen Sie required: truefür den Hauptparameter wie folgt ein:

    type: object
    required: true
    gui:
      collapse_pane: true
<!--NeedCopy-->

Das Attribut collapse_pane zeigt das Objekt und seine Unterparameter in der Benutzeroberfläche reduziert an, es sei denn, der Benutzer erweitert den Bereich.

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 Citrix ADM GUI wird der Benutzer aufgefordert, einen Parameterwert aus dieser Liste auszuwählen.

Beispiel 1:

 -
   name: ipaddress
   type: string
   allowed-values:
     -  SOURCEIP
     -  DEST IP
     -  NONE
<!--NeedCopy-->

Beispiel 2:

 -
   name: TCP Port
   type: tcp-port
   allowed-values:
     -  80
     -  81
     -  8080
<!--NeedCopy-->

Beispiel 3:

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

  -
    name: tcpports
    type: tcp-port[]
    allowed-values:
      -  80
      -  81
      -  8080
      -  8081
<!--NeedCopy-->

Obligatorisch? Nein

default

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 Citrix ADM GUI keinen Wert für einen Parameter angibt, der keinen Standardwert hat, wird für diesen Parameter kein Wert festgelegt.

Beispiel 1:

  -
    name: timeout
    type: number
    default: 20
<!--NeedCopy-->

Beispiel 2:

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

  -
    name: protocols
    type: string[]
    default:
      - TCP
      - UDP
      - IP
<!--NeedCopy-->

Beispiel 3:

  -
    name: timeout
    type: number
    default: 20
<!--NeedCopy-->

Beispiel 4:

  -
    name: tcpport
    type: tcp-port
    default: 20
<!--NeedCopy-->

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]+"
<!--NeedCopy-->

Obligatorisch? Nein

min-Wert

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
<!--NeedCopy-->

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

Obligatorisch? Nein

Max-Wert

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
<!--NeedCopy-->

Obligatorisch? Nein

min-Länge

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-length: 3
<!--NeedCopy-->

Obligatorisch? Nein

Max-Länge

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
<!--NeedCopy-->

Obligatorisch? Nein

min-Artikel

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
<!--NeedCopy-->

Obligatorisch? Nein

Max-Artikel

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
<!--NeedCopy-->

Obligatorisch? Nein

GUI

Verwenden Sie dieses Attribut, um das Layout des Parameters vom Typ “object” in der Citrix ADM GUI anzupassen.

Obligatorisch? Nein

Spalten

Dies ist ein Unterattribut des GUI-Attributs. Dieses Attribut wird für Parameter der Objekttypliste verwendet. Diese Parameter werden in der GUI als Tabelle angezeigt. Jede Zeile stellt ein Objekt in der Liste dar, und die Spalten stellen die Objektschlüssel dar. Verwenden Sie diese Option, um die Anzahl der Spalten zu definieren, die in der Citrix ADM GUI angezeigt werden sollen.

Standardmäßig werden alle Objektschlüssel vom Typ string angezeigt.

Obligatorisch? Nein

aktualisierbar

Dies ist ein Unterattribut des GUI-Attributs. Mit dieser Option können Sie angeben, ob der Parameter nach der Erstellung der Konfiguration aktualisiert werden kann.

Wenn der Wert auf false gesetzt ist, wird das Parameterfeld ausgegraut, wenn Sie die Konfiguration aktualisieren.

Obligatorisch? Nein

Ausblend_Fensterbereich

Dies ist ein Unterattribut des GUI-Attributs. Geben Sie hier an, ob der Bereich, der das Layout dieses Objektparameters definiert, zusammenklappbar ist.

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
 updatable: false
<!--NeedCopy-->

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
<!--NeedCopy-->

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
<!--NeedCopy-->
Parameter
July 1, 2020
Beigesteuert von: 
C
July 1, 2020
Beigesteuert von: 
C

In diesem Artikel

Feedback zur Site | Datenschutz und rechtliche Hinweise | Cookie-Einstellungen | Consent settings
© 1999- Citrix Systems, Inc. All rights reserved.