Citrix Application Delivery Management

Parámetros

Esta sección le permite definir todos los parámetros que necesita en su StyleBook para crear una configuración. Describe la entrada que toma su StyleBook. Aunque esta es una sección opcional, la mayoría de los StyleBooks pueden necesitar una. Puede considerar la sección de parámetros para definir las preguntas que quiere que los usuarios respondan cuando utilicen StyleBook para crear una configuración en una instancia de Citrix ADC.

Cuando importa StyleBook a Citrix ADM y lo utiliza para crear una configuración, la GUI utiliza esta sección del StyleBook para mostrar un formulario que toma los valores de los parámetros definidos.

En la siguiente sección se describen los atributos que debe especificar para cada parámetro de esta sección:

nombre

El nombre del parámetro que quiere definir. Puede especificar un nombre alfanumérico.

El nombre debe comenzar por un alfabeto y puede incluir alfabetos adicionales, números, guión (-) o guión bajo (_).

Tenga en cuenta que al escribir un StyleBook, puede usar este atributo “name” para hacer referencia al parámetro en otras secciones mediante el uso de la notación $parameters. -<name> Sí.

¿Obligatorio? Sí

etiqueta

Cadena que se muestra en la GUI de ADM como nombre de este parámetro.

¿Obligatorio? NO

descripción

Cadena de ayuda que describe para qué se utiliza el parámetro. La GUI de ADM muestra este texto cuando el usuario hace clic en el icono de ayuda de este parámetro.

¿Obligatorio? NO

tipo

El tipo de valor que pueden tomar estos parámetros. Los parámetros pueden ser de cualquiera de los siguientes tipos incorporados:

  • string: Una matriz de caracteres. Si no se especifica una longitud, el valor de cadena puede tener cualquier número de caracteres. Sin embargo, puede limitar la longitud de un tipo de cadena mediante los atributos min-length y max-length.

  • number: Un número entero. Puede especificar el número mínimo y máximo que puede tomar este tipo mediante los atributos min-value y max-value.

  • boolean: Puede ser verdadero o falso. Además, tenga en cuenta que todos los literales son considerados por YAML como booleanos (por ejemplo, Sí o No).

  • ipaddress: Cadena que representa una dirección IPv4 o IPv6 válida.

  • tcp-port: Número entre 0 y 65535 que representa un puerto TCP o UDP.

  • password: Representa un valor de cadena opaque/secret. Cuando Citrix ADM GUI muestra un valor para este parámetro, se muestra como asteriscos (*****).

  • certfile: Representa un archivo de certificado. Esto le permite cargar los archivos directamente desde su sistema local cuando está creando una configuración de StyleBook mediante la GUI de ADM. El archivo de certificado cargado se almacena en el directorio /var/mps/arrendatarios/<arrendatario_path>/ns_ssl_certs en ADM.

    El archivo de certificado se agregará a la lista de certificados administrados por ADM.

  • keyfile: Representa un archivo de clave de certificado. Esto le permite cargar el archivo directamente desde su sistema local cuando está creando una configuración de StyleBook con la GUI Citrix ADM. El archivo de certificado cargado se almacena en el directorio /var/mps/arrendatarios/<arrendatario_path>/ns_ssl_keys de Citrix ADM.

    El archivo de clave de certificado se agregará a la lista de claves de certificado administradas por Citrix ADM.

  • file: Representa un archivo.

  • object: Este tipo se utiliza cuando se quiere agrupar varios parámetros relacionados bajo un elemento principal. Debe especificar el parámetro principal el tipo como “objeto”. Un parámetro de tipo “objeto” puede tener una sección “parámetros” anidada para describir los parámetros que contiene.

  • otro StyleBook: Cuando se utiliza este tipo de parámetro, este parámetro espera que su valor sea en forma de los parámetros definidos en el StyleBook que denota su tipo.

Un parámetro también puede tener un tipo que sea una lista de cualquiera de los tipos enumerados anteriormente, agregando “[]” al final del tipo. Por ejemplo, si el atributo type es string [], este parámetro toma una lista de cadenas como entrada. Puede proporcionar una, dos o varias cadenas para este parámetro al crear una configuración a partir de este StyleBook.

¿Obligatorio? Sí

clave

Especifique true o false para indicar si este parámetro es un parámetro clave para StyleBook.

Un StyleBook puede tener solo un parámetro definido como el parámetro “clave”.

Cuando crea configuraciones diferentes a partir del mismo StyleBook (en las mismas instancias de Citrix ADC o diferentes), cada configuración tiene un valor diferente o único para este parámetro.

El valor predeterminado es false.

¿Obligatorio? NO

obligatorio

Especifique true o false para indicar si un parámetro es obligatorio u opcional. Si se establece en true, el parámetro es obligatorio. Un usuario debe proporcionar un valor para un parámetro obligatorio para crear una configuración a menos que se defina un valor predeterminado.

La GUI de Citrix ADM obliga al usuario a proporcionar un valor válido para este parámetro.

El valor predeterminado es false.

¿Obligatorio? NO

Nota

Si un parámetro tienetype: object yrequired: false, los subparámetros de este parámetro no se evalúan.

Si quiere que el valor predeterminado de los subparámetros surta efecto, establezcarequired: true para el parámetro principal de la siguiente manera:

    type: object
    required: true
    gui:
      collapse_pane: true

El atributo collapse_pane muestra el objeto y sus subparámetros contraídos en la interfaz de usuario, a menos que el usuario expanda el panel.

valores permitidos

Utilice este atributo para definir una lista de valores válidos para un parámetro, cuando el tipo se establece en “string. “

Al crear una configuración desde la GUI de Citrix ADM, se solicita al usuario que seleccione un valor de parámetro de esta lista.

Ejemplo 1:

 -
   name: ipaddress
   type: string
   allowed-values:
     -  SOURCEIP
     -  DEST IP
     -  NONE

Ejemplo 2:

 -
   name: TCP Port
   type: tcp-port
   allowed-values:
     -  80
     -  81
     -  8080

Ejemplo 3:

(lista de tcp-ports, donde cada elemento de la lista solo puede tener valores especificados en valores permitidos)

  -
    name: tcpports
    type: tcp-port[]
    allowed-values:
      -  80
      -  81
      -  8080
      -  8081

¿Obligatorio? NO

predeterminada

Utilice este atributo para asignar un valor predeterminado a un parámetro opcional. Al crear una configuración, si un usuario no especifica un valor, se utiliza el valor predeterminado.

Al crear la configuración desde la GUI de Citrix ADM, si un usuario no proporciona un valor para un parámetro que no tiene un valor predeterminado, no se establece ningún valor para ese parámetro.

Ejemplo 1:

  -
    name: timeout
    type: number
    default: 20

Ejemplo 2:

(donde, el valor predeterminado del parámetro es una lista de valores):

  -
    name: protocols
    type: string[]
    default:
      - TCP
      - UDP
      - IP

Ejemplo 3:

  -
    name: timeout
    type: number
    default: 20

Ejemplo 4:

  -
    name: tcpport
    type: tcp-port
    default: 20

¿Obligatorio? NO

patrón

Utilice este atributo para definir un patrón (expresión regular) para los valores válidos de este parámetro, cuando el tipo del parámetro es “string. “

Ejemplo:

  -
    name: appname
    type: string
    pattern: "[a-z]+"

¿Obligatorio? NO

min-value

Utilice este atributo para definir el valor mínimo para los parámetros del tipo “number” o “tcp-port. “

Ejemplo:

  -
    name: audio-port
    type: tcp-port
    min-value: 5000

El valor min-valor de los números puede ser negativo, pero el valor min-valor para tcp-port no debe ser negativo.

¿Obligatorio? NO

max-value

Utilice este atributo para definir el valor máximo para los parámetros del tipo “number” o “tcp-port. “

El valor máximo debe ser mayor que el valor mínimo, si se define.

Ejemplo:

  -
    name: audio-port
    type: tcp-port
    min-value: 5000
    max-value: 15000

¿Obligatorio? NO

min-length

Utilice este atributo para definir la longitud mínima de los valores aceptados para un parámetro de tipo “string. “

La longitud mínima de los caracteres definidos como valores debe ser mayor o igual a cero.

Ejemplo:

  -
    name: appname
    type: string
    min-length: 3

¿Obligatorio? NO

max-length

Utilice este atributo para definir la longitud máxima de los valores aceptados para un parámetro de tipo “string. “

La longitud máxima de los valores debe ser mayor o igual a la longitud de los caracteres definidos en min-length.

Ejemplo:

  -
    name: appname
    type: string
    max-length: 64

¿Obligatorio? NO

min-items

Utilice este atributo para definir el número mínimo de elementos en un parámetro que es una lista.

El número mínimo de elementos debe ser mayor o igual a cero.

Ejemplo:

  -
    name: server-ips
    type: ipaddress[]
    min-items: 2

¿Obligatorio? NO

max-items

Utilice este atributo para definir el número máximo de elementos en un parámetro que es una lista.

El número máximo de elementos debe ser mayor que el número mínimo de elementos si se define.

Ejemplo:

  -
    name: server-ips
    type: ipaddress[]
    min-items: 2
    max-items: 250

¿Obligatorio? NO

GUI

Utilice este atributo para personalizar el diseño del parámetro de tipo “object” en la GUI de Citrix ADM.

¿Obligatorio? NO

columnas

Este es un subatributo del atributo gui. Este atributo se utiliza para los parámetros de la lista de tipos de objetos. Estos parámetros se muestran en la GUI como una tabla. Cada fila representa un objeto de la lista y las columnas representan las claves de objeto. Utilice esta opción para definir el número de columnas que se mostrarán en la GUI de Citrix ADM.

De forma predeterminada, se muestran todas las claves de objeto de tipo string.

¿Obligatorio? NO

actualizable

Este es un subatributo del atributo gui. Utilice esta opción para especificar si el parámetro se puede actualizar después de crear la configuración.

Si el valor se establece en false, el campo de parámetro aparece atenuado al actualizar la configuración.

¿Obligatorio? NO

collapse_pane

Este es un subatributo del atributo gui. Utilice esta opción para especificar si el panel que define el diseño de este parámetro de objeto es contraíble.

Si el valor se establece en true, el usuario puede expandir o contraer los parámetros secundarios bajo este parámetro principal.

Ejemplo:

gui:
 collapse_pane: true
 columns: 2
 updatable: false

Ejemplo de una sección completa de parámetros:


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

A continuación se muestra un ejemplo que define todos los atributos de una lista y los valores explicados en secciones anteriores:

  -
    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