Documentación de productos
Application Delivery Management
14.1 - Current Release 13.1 13.0 12.1
Ver PDF

Parámetros

January 30, 2024
Contribución de: 
C

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, es posible que la mayoría de los StyleBooks la necesiten. Puede consultar la sección de parámetros para definir las preguntas a las que desea que respondan los usuarios cuando usen el StyleBook para crear una configuración en una instancia de Citrix ADC.

Al importar el StyleBook a Citrix ADM y usarlo para crear una configuración, la GUI utiliza esta sección del StyleBook para mostrar un formulario que introduce los valores de los parámetros que ha definido.

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

name

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

El nombre debe empezar por un alfabeto y puede incluir alfabetos, números, guiones (-) o caracteres de subrayado (_) adicionales.

Tenga en cuenta que al escribir un StyleBook, puede usar este atributo «name» para hacer referencia al parámetro en otras secciones utilizando la notación $parameters. <name>.

¿Obligatorio? Sí

etiqueta

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

¿Obligatorio? No

description

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

type

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

  • cadena: 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 utilizando los atributos longitud mínima y longitud máxima.

  • number: un número entero. Puede especificar el número mínimo y máximo que puede tomar este tipo mediante los atributos valor mínimo y valor máximo.

  • booleano: puede ser verdadero o falso. Además, ten en cuenta que YAML considera todos los literales 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.

  • contraseña: representa un valor de cadena opaco o secreto. Cuando la GUI de Citrix ADM muestra un valor para este parámetro, aparece con asteriscos (*****).

  • certfile: representa un archivo de certificado. Esto le permite cargar los archivos directamente desde su sistema local al crear una configuración de StyleBook mediante la GUI de ADM. El archivo de certificado cargado se almacena en el directorio /var/mps/tenants//ns_ssl_certs en ADM.

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

  • keyfile: representa un archivo de claves de certificado. Esto le permite cargar el archivo directamente desde el sistema local al crear una configuración de StyleBook mediante la GUI de Citrix ADM. El archivo de certificado cargado se almacena en el directorio /var/mps/tenants//ns_ssl_keys en Citrix ADM.

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

  • archivo: representa un archivo.

  • objeto: este tipo se usa cuando desea agrupar varios parámetros relacionados en un elemento principal. Debe especificar el parámetro principal del tipo como «objeto». Un parámetro de tipo “objeto” puede tener una sección de “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, añadiendo «[]» al final del tipo. Por ejemplo, si el atributo de tipo 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 solo puede tener un parámetro definido como parámetro “clave”.

Al crear diferentes configuraciones desde el mismo StyleBook (en la misma instancia de Citrix ADC o en diferentes instancias), cada configuración tiene un valor diferente o único para este parámetro.

El valor predeterminado es false.

¿Obligatorio? No

requerido

Especifique true o false para indicar si un parámetro es obligatorio u opcional. Si se establece en true, el parámetro es obligatorio y el usuario debe proporcionar un valor para este parámetro al crear configuraciones.

La GUI de NetScaler 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 tiene type: object y required: false, los subparámetros de este parámetro no se evalúan.

Si desea que el valor predeterminado de los subparámetros surta efecto, defina required: true para main-parameter de la siguiente manera:

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

El atributo collapse_pane muestra el objeto y sus subparámetros contraídos en la interfaz de usuario, a menos que el usuario amplíe 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 “cadena”.

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

Ejemplo 1:

nombre: dirección IP

tipo: Cadena

valores permitidos:

  • SOURCEIP
  • CONSEJO DE REPOSO
  • NONE

Ejemplo 2:

nombre: TCP Port

type: Tcp-port

valores permitidos:

  • 80
  • 81
  • 8080

Ejemplo 3:

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

nombre: Tcpports

tipo: puerto tcp []

valores permitidos:

  • 80
  • 81
  • 8080
  • 8081

¿Obligatorio? No

default

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:

nombre: timeout

tipo: número

adulto sordo: 200

Ejemplo 2:

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

nombre: Protocolos

tipo: cadena []

predeterminado:

  • TCP
  • UDP
  • IP

Ejemplo 3:

nombre: timeout

tipo: número

adulto sordo: 200

Ejemplo 4:

nombre: tcpport

type: Tcp-port

adulto sordo: 200

¿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 sea “cadena”.

Ejemplo:

nombre: appname

tipo: Cadena

patrón: «[a-z] +»

¿Obligatorio? No

valor mínimo

Utilice este atributo para definir el valor mínimo de los parámetros de tipo «number» o «tcp-port». «

Ejemplo:

nombre: audio-port

type: Tcp-port

valor mínimo: 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

valor máximo

Utilice este atributo para definir el valor máximo de los parámetros de tipo «number» o «tcp-port». «

El valor máximo debe ser mayor que el valor mínimo, si está definido.

Ejemplo:

nombre: audio-port

type: Tcp-port

valor mínimo: 5000

valor máximo: 15000

¿Obligatorio? No

longitud mínima

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

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

Ejemplo:

nombre: appname

tipo: Cadena

longitud mínima: 3

¿Obligatorio? No

longitud máxima

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

La longitud máxima de los valores debe ser mayor o igual a la longitud de los caracteres definidos en la longitud mínima.

Ejemplo:

nombre: appname

tipo: Cadena

longitud máxima: 64

¿Obligatorio? No

artículos mínimos

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

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

Ejemplo:

nombre: Server-ips

tipo: dirección IP []

artículos mínimos: 2

¿Obligatorio? No

artículos máximos

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

La cantidad máxima de artículos debe ser mayor que la cantidad mínima de artículos si está definida.

Ejemplo:

nombre: Server-ips

tipo: dirección IP []

artículos mínimos: 2

número máximo de artículos: 250

¿Obligatorio? No

interfaz gráfica

Utilice este atributo para personalizar el diseño del parámetro de tipo «objeto» en la GUI de Citrix ADM.

¿Obligatorio? No

columnas

Este es un subatributo del atributo gui. Úselo para definir el número de columnas que se mostrarán en la GUI de Citrix ADM.

¿Obligatorio? No

actualizable

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

Si el valor se establece en falso, el campo del parámetro aparece en gris al actualizar la configuración.

¿Obligatorio? No

colapsar panel

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 plegable.

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

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

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

```Nombre YAML    : features-list

tipo: cadena []**

longitud mínima: 1

longitud máxima: 3

artículos mínimos: 1

número máximo de artículos: 3

patrón: «[A-Z] +»

valores permitidos:

- 1 CUCHARADITA

- LIBRA

- 4 PIEZAS

predeterminado:

- LIBRA

Parámetros
January 30, 2024
Contribución de: 
C
January 30, 2024
Contribución de: 
C

En este artículo

Comentarios sobre el sitio | Condiciones legales y de privacidad | Preferencias de cookies | Parámetros de consentimiento | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.