Usar una instancia de NetScaler como origen de datos
Puede usar las instancias de NetScaler administradas como orígenes de datos. El
managed-adc es un tipo de origen de datos integrado que se puede usar fácilmente como origen de datos en NetScaler Console. Cada instancia de NetScaler administrada en NetScaler Console es un origen de datos de forma predeterminada. Puede empezar a usar estos orígenes de datos en sus StyleBooks si necesita datos de un NetScaler existente administrado por NetScaler Console al crear paquetes de configuración.
En la definición de StyleBook, especifique el parámetro de tipo integrado
datum. Puede usar los tipos de origen de datos en su StyleBook. Los usuarios de StyleBook pueden seleccionar un origen de datos que se pueda usar para recuperar datos de ese origen.
Uso del origen de datos integrado sin recopilación
parameters:
- name: selected-adc
label: Select an existing NetScaler
type: datum
required: true
data-source:
type: managed-adc
En el ejemplo, el parámetro
datum se usa para seleccionar cualquier instancia de NetScaler administrada por NetScaler Console. El origen de datos integrado managed-adc le permite recuperar datos de cualquier instancia de NetScaler administrada por NetScaler Console.
En su StyleBook, puede acceder a cualquier configuración de la instancia de NetScaler seleccionada. Y puede usar esa configuración al crear o actualizar configuraciones en el mismo NetScaler o en una instancia de NetScaler diferente; depende de la instancia de NetScaler de destino seleccionada.
Acceder a la recopilación desde un origen de datos:
En la instancia de NetScaler seleccionada, para acceder a una recopilación, use la siguiente expresión:
$parameters.selected-adc.collections.<collection-name>
Ejemplo:
$parameters.selected-adc.collections.lbvserver
Esta expresión devuelve la lista de entidades
lbvserver en la instancia de NetScaler seleccionada. Por ejemplo, puede iterar sobre esta lista para seleccionar un lbvserver específico que cumpla una determinada condición.
Ejemplo de StyleBook sin recopilación
name: add-vservers-from-managed-adc-instances
namespace: com.citrix.adc.stylebooks
version: "1.0"
schema-version: "1.0"
import-stylebooks:
-
namespace: netscaler.nitro.config
prefix: ns
version: "10.5"
parameters:
-
name: selected-adc
label: Select a NetScaler instance
type: datum
required: true
data-source:
type: "managed-adc"
components:
-
name: sslvserver-comp
type: ns::sslvserver
repeat: $parameters.selected-adc.collections.lbvserver
repeat-item: lbvs
repeat-condition: $lbvs.attributes.servicetype == "SSL"
properties:
name: $lbvs.attributes.name
ssl2: DISABLED
ssl3: DISABLED
tls1: DISABLED
tls11: ENABLED
tls12: ENABLED
La GUI del paquete de configuración muestra las instancias de NetScaler administradas por NetScaler Console y los usuarios de StyleBook pueden seleccionar cualquier NetScaler al crear o actualizar el paquete de configuración.
Este StyleBook usa el NetScaler seleccionado e itera sobre todas las entidades
lbvserver. Selecciona los servidores virtuales SSL y establece las versiones de protocolo SSL permitidas en cada servidor virtual.
La siguiente expresión le permite iterar a través de la lista de entidades
lbvserver en la instancia de NetScaler.
repeat: $parameters.selected-adc.collections.lbvserver
-
collections: Se refiere a todos los tipos de entidad en la instancia de NetScaler. Por ejemplo,csvserver,lbmonitor,servicegroup, etc. -
lbvserver: Se refiere a la lista de entidades de servidor virtual de equilibrio de carga en la instancia de NetScaler.
Uso del origen de datos integrado con la recopilación
parameters:
- name: selected-lbvserver
label: Select an existing lbvserver
type: datum
required: true
data-source:
type: managed-adc
collection: lbvserver
En este ejemplo, el parámetro
datum se utiliza para permitir que un usuario seleccione tanto la instancia de NetScaler como un lbvserver específico del tipo de origen de datos managed-adc.
Cuando se define un tipo de recopilación en la sección
parameters, los usuarios de StyleBook pueden seleccionar la instancia de NetScaler y una entidad específica de una recopilación en esa instancia.
Acceder a un atributo del elemento seleccionado:
Cuando el usuario de StyleBook selecciona un servidor virtual, la siguiente expresión en su StyleBook puede acceder a cualquier atributo del elemento seleccionado.
$parameters.selected-lbvserver.attributes.<attribute-name>
En este ejemplo, el
datum seleccionado es lbvserver. Por lo tanto, puede acceder a cualquier atributo de la entidad de NetScaler lbvserver, como name, servicetype, ipv46, etc.
Ejemplo:
$parameters.selected-lbvserver.attributes.ipv46
Esta expresión recupera la IP del servidor virtual de equilibrio de carga seleccionado. Para obtener más información sobre las entidades (colecciones) de NetScaler y sus atributos, consulte Referencia de la API NITRO de NetScaler.
Seleccionar varios elementos de una colección:
La siguiente sección de parámetros permite a los usuarios de StyleBook seleccionar varios elementos de una colección.
parameters:
- name: selected-lbvservers
label: Select existing lbvservers
type: datum[]
required: true
data-source:
type: managed-adc
collection: lbvserver
En este ejemplo, el parámetro de dato se utiliza para definir la matriz de origen de datos. El usuario puede seleccionar uno o varios lbvservers de una única instancia de NetScaler® o de varias instancias de NetScaler.
El siguiente fragmento de código muestra cómo acceder a los elementos seleccionados y sus atributos.
components:
- name: sslvserver-comp
type: ns::sslvserver
repeat:
repeat-list: $parameters.selected-lbvservers
repeat-item: vserverObj
properties:
name: $vserverObj.attributes.name
ssl2: DISABLED
ssl3: DISABLED
tls1: DISABLED
tls11: ENABLED
tls12: ENABLED
Acceder a una colección por la referencia del elemento seleccionado:
Además de permitir que un usuario de StyleBook seleccione una entidad específica en una instancia de NetScaler administrada, también puede acceder a cualquier entidad de la misma o de diferentes colecciones en la instancia de NetScaler seleccionada. Para acceder a otra colección en esa instancia de NetScaler, utilice la siguiente expresión en la sección
components:
$parameters.selected-lbvserver.datasource.collections.<collection-name>
Ejemplo:
$parameters.selected-lbvserver.datasource.collections.csvserver
Esta expresión devuelve la lista de servidores virtuales de conmutación de contenido de la instancia de NetScaler seleccionada.
Y la siguiente expresión devuelve una lista de todas las vinculaciones entre
lbvservers y servicegroups:
$parameters.selected-lbvserver.datasource.collections.lbvserver_servicegroup_binding
Ejemplo de StyleBook con una colección
El siguiente es un ejemplo de StyleBook para demostrar cómo usar la instancia de NetScaler administrada como origen de datos:
name: bind-lb-to-servicegroup-using-ADC-as-datasource
namespace: com.citrix.adc.stylebooks
version: "1.1"
display-name: "HTTP/SSL LoadBalancing StyleBook with Service Binding"
description: "This stylebook defines a typical Load Balanced Application configuration where we allow the user to select an existing lbvserver on the NetScaler using datum type parameter. Then a servicegroup for the selected lb is created if it does not exist on the NetScaler. Finally, the selected lbvserver is bound to the service "
schema-version: "1.0"
import-stylebooks:
-
namespace: netscaler.nitro.config
prefix: ns
version: "10.5"
parameters:
-
name: selected-vserver
label: "Select an Existing VServer"
description: "Load Balancing Application Vservers to be bound to service on the ADC"
type: datum
required: true
data-source:
type: managed-adc
collection: lbvserver
components:
-
name: servicegroup-discovery-comp
type: object
repeat: $parameters.selected-vserver.datasource.collections.servicegroup
repeat-item: svcgrp
repeat-condition: $svcgrp.attributes.servicegroupname == $parameters.selected-vserver.attributes.name + "-svcgrp"
properties:
servicegroupname: $svcgrp.attributes.servicegroupname
-
name: servicegroup-creation-if-not-exists-comp
type: ns::servicegroup
condition: not exists($components.servicegroup-discovery-comp)
properties:
servicegroupname: $parameters.selected-vserver.attributes.name + "-svcgrp"
servicetype: $parameters.selected-vserver.attributes.servicetype
components:
-
name: lbvserver-servicegroup-binding
type: ns::lbvserver_servicegroup_binding
properties:
name: $parameters.selected-vserver.attributes.name
servicegroupname: $parent.properties.servicegroupname
En este StyleBook, la sección
components comprueba el nombre del grupo de servicios que coincide con el nombre del servidor virtual de equilibrio de carga seleccionado concatenado con svcgrp.
Si el nombre del servidor virtual de equilibrio de carga seleccionado es
lbv1, este StyleBook comprueba el grupo de servicios con el nombre lbv1-svcgrp. Si no se encuentra, crea un grupo de servicios lbv1-svcgrp y lo vincula con el servidor virtual lbv1.
La siguiente expresión obtiene la lista de grupos de servicios en la instancia de NetScaler.
repeat: $parameters.selected-vserver.datasource.collections.servicegroup
En esta expresión:
-
datasource: Se refiere a la instancia de NetScaler seleccionada administrada por NetScaler Console. -
collections: Se refiere a todas las entidades de la instancia de NetScaler. -
servicegroup: Se refiere a los grupos de servicios en la instancia de NetScaler.
Filtrado de datos de la colección:
La siguiente sección de parámetros explica cómo especificar filtros en una colección de origen de datos integrada en la definición de StyleBook. Permite a los usuarios de StyleBook seleccionar un elemento específico de una colección filtrada.
parameters:
- name: selected-lbvserver
label: Select an existing lbvserver
type: datum
required: true
data-source:
type: managed-adc
collection: lbvserver
collection-filters:
protocol: SSL
En este ejemplo, el parámetro datum se utiliza para permitir que un usuario seleccione tanto la instancia de NetScaler como un lbvserver específico con protocolo SSL del tipo de origen de datos managed-adc.
Después de que el usuario de StyleBook seleccione un servidor virtual, se puede acceder a cualquier atributo del elemento seleccionado de la misma manera que se explicó en la sección anterior.