Funciones integradas
Las expresiones en StyleBooks pueden hacer uso de funciones integradas.
Por ejemplo, puede usar la función incorporada, str() para transformar un número en una cadena.
str($parameters.order)
O bien, puede usar la función incorporada, int() para transformar una cadena en un entero.
int($parameters.priority)
La siguiente es la lista de funciones integradas admitidas en expresiones StyleBook con ejemplos de cómo se pueden usar:
str()
La función str() transforma el argumento de entrada en un valor de cadena.
Tipos de argumentos permitidos:
stringnumberTCP-portbooleanIP address
Ejemplos:
- La función
"set-" + str(10)devuelve"set-10". - La función
str(10)devuelve10. - La función
str(1.1.1.1)devuelve1.1.1.1. - La función
str(T rue)devuelve"T rue". - La función
str(ADM)devuelve"mas".
int()
La función int() toma una cadena, un número, una dirección IP, o tcpport como argumento y devuelve un entero.
Ejemplos:
- La función
int("10")devuelve10. - La función
int(10)devuelve10. - La función
int(ip('0.0.4.1'))devuelve1025.
bool()
La función bool() toma cualquier tipo como argumento. Si el valor del argumento es false, vacío o ausente, esta función devuelve false.
De lo contrario, regresa true.
Ejemplos:
- La función
bool(true)devuelvetrue. - La función
bool(false)devuelvefalse. - La función
bool($parameters.a)devuelvefalsesi el$parameters.aesfalse, vacío o ausente.
len()
La función len() toma una cadena o una lista como argumento y devuelve el número de caracteres de una cadena o el número de elementos de una lista.
Ejemplo 1:
Si define una sustitución de la siguiente manera:
items: ["123", "abc", "xyz"]
La función len($substitutions.items) devuelve 3
Ejemplo 2:
La función len("NetScaler ADM") devuelve 10.
Ejemplo 3:
Si $parameters.vips tiene valores ['1.1.1.1', '1.1.1.2', '1.1.1.3'], la función len($parameters.vips) devuelve 3.
min()
La min() función toma ya sea una lista o una serie de números o tcp-ports como argumentos, y devuelve el elemento más pequeño.
Ejemplos con una serie de números/tcp-ports:
- La función
min(80, 100, 1000)devuelve80. - La función
min(-20, 100, 400)devuelve-20. - La función
min(-80, -20, -10)devuelve-80. - La función
min(0, 100, -400)devuelve-400.
Ejemplos con una lista de números/tcp-ports:
-
$parameters.portsEl soporte es una lista detcp-portsy tiene valores:[80, 81, 8080].La función
min($parameters.ports)devuelve80.
max()
La max() función toma ya sea una lista o una serie de números o tcp-ports como argumentos, y devuelve el elemento más grande.
Ejemplos con una serie de números/tcp-ports:
- La función
max(80, 100, 1000)devuelve1000. - La función
max(-20, 100, 400)devuelve400. - La función
max(-80, -20, -10)devuelve-10. - La función
max(0, 100, -400)devuelve100.
Ejemplos con una lista de números/tcp-ports:
-
$parameters.portsEl soporte es una lista detcp-portsy tiene valores:[80, 81, 8080].La función
max($parameters.ports)devuelve8080.
bin()
La función bin() toma un número como argumento y devuelve una cadena que representa el número en formato binario.
Ejemplos de expresiones:
La función bin(100) devuelve 0b1100100.
oct()
La función oct() toma un número como argumento y devuelve una cadena que representa el número en formato octal.
Ejemplos de expresiones:
La función oct(100) devuelve 0144.
hex()
La función hex() toma un número como argumento y devuelve una cadena en minúsculas que representa el número en formato hexadecimal.
Ejemplos de expresiones:
La función hex(100) devuelve 0x64.
lower()
La función lower() toma una cadena como argumento y devuelve la misma cadena en minúsculas.
Ejemplo:
La función lower("ADM") devuelve adm.
upper()
La función upper() toma una cadena como argumento y devuelve la misma cadena en mayúsculas.
Ejemplo:
La función upper("NetScaler ADM") devuelve NetScaler ADM.
sum()
La función sum() toma una lista de números o tcpports como argumentos y devuelve la suma de los números en la lista.
Ejemplo 1:
Si define una sustitución de la siguiente manera: sustituciones:
list-of-numbers = [11, 22, 55]
La función sum($substitutions.list-of-numbers) devuelve 88.
Ejemplo 2:
Si $parameters.ports es [80, 81, 82], la función sum($parameters.ports) devuelve 243.
pow()
La función pow() toma dos números como argumentos y devuelve un número que representa el primer argumento elevado a la potencia del segundo.
Ejemplo:
La función pow(3,2) devuelve 9.
ip()
La función ip() toma un entero, una cadena o una dirección IP como argumento y devuelve la dirección IP basada en el valor de entrada.
Ejemplos:
-
Especifique una dirección IP en la función
ip:La función
ip(3.1.1.1)devuelve3.1.1.1. -
Especifique una cadena en la función
ip:La función
ip('2.1.1.1')devuelve2.1.1.1 -
Especifique un entero en la función
ip:-
La función
ip(12)devuelve0.0.0.12. -
Cuando se especifica un entero como cadena en la función
ip, devuelve una dirección IP equivalente de la entrada.La función
ip('1025')devuelve0.0.4.1.
Esta función también admite las operaciones de suma y resta enteros y devuelve una dirección IP resultante.
-
Adición: La función
ip(1025) + ip(12)devuelve0.0.4.13. -
Resta: la función
ip('1025') - ip(12)devuelve0.0.3.245. -
Combinar suma y resta: Los
ip('1.1.1.1') + ip('1.1.1.1') – ip(2)retornos2.2.2.0.
-
base64.encode()
La función base64.encode() toma un argumento de cadena y devuelve la cadena codificada base64.
Ejemplo:
La función base64.encode("abcd") devuelve YWJjZA==.
base64.decode()
La función base64.decode toma una cadena codificada base64 como argumento y devuelve la cadena decodificada.
Ejemplo:
La función base64.decode("YWJjZA==") devuelve abcd.
exists()
La función exists() toma un argumento de cualquier tipo y devuelve un booleano. El valor devuelto es True si la entrada tiene algún valor. El valor devuelto es False Si el argumento de entrada no tiene un valor (es decir, no hay valor).
Tenga en cuenta que $parameters.monitor es un parámetro opcional. Si proporciona un valor a este parámetro al crear un paquete de configuración, existe la función ($parameters.monitor) devuelve True.
De lo contrario, regresa False.
filter()
La función filter() toma dos argumentos.
Argumento 1: una función de sustitución que toma un argumento y devuelve un valor booleano.
Argumento 2: una lista.
La función devuelve un subconjunto de la lista original donde cada elemento evalúa True cuando se pasa a la función de sustitución en el primer
argumento.
Ejemplo:
Supongamos que hemos definido una función de sustitución de la siguiente manera.
Sustituciones:
x(a): $a != 81
Esta función devuelve True si el valor de entrada no es igual a 81. De lo contrario, regresa False.
Supongamos que $parameters.ports es [81, 80, 81, 89].
filter($substitutions.x, $parameters.ports) devuelve [80, 89] eliminando todas las apariciones de 81 de la lista.
if-then-else()
La función if-then-else() toma tres argumentos.
Argumento 1: Expresión booleana
Argumento 2: Cualquier expresión
Argumento 3: Cualquier expresión (opcional)
Si la expresión en el argumento 1 se evalúa como True, la función devuelve el valor de la expresión proporcionada como argumento 2.
De lo contrario, si se proporciona el argumento 3, la función devuelve el valor de la expresión en el argumento 3.
Si no se proporciona el argumento 3, la función devuelve no.
Ejemplo 1:
La función if-then-else($parameters.servicetype == HTTP, 80, 443) devuelve 80 si $parameters.servicetype tiene valor HTTP. De lo contrario, la función devuelve 443.
Ejemplo 2:
La función if-then-else($parameters.servicetype == HTTP, $parameters.hport, $parameters.sport) devuelve el valor de $parameters.hport if $parameters.servicetype tiene valor HTTP.
De lo contrario, la función devuelve el valor de $parameters.sport.
Ejemplo 3:
if-then-else($parameters.servicetype == HTTP, 80) devuelve 80 si $parameters.servicetype tiene valor HTTP.
De lo contrario, la función no devuelve ningún valor.
join()
La función join() toma dos argumentos:
Argumento 1: lista de números tcp-ports, cadenas o direcciones IP
Argumento 2: cadena delimitadora (opcional)
Esta función une los elementos de la lista proporcionada como argumento uno en una cadena, donde cada elemento está separado por la cadena delimitador proporcionada como argumento dos. Si no se proporciona el argumento dos, entonces los elementos de la lista se unen como una sola cadena.
Ejemplo:
-
$parameters.portses[81, 82, 83].-
Con argumento delimitador:
La función
join($parameters.ports, '-')devuelve81-82-83. -
Sin argumento delimitador:
La función
join($parameters.ports)devuelve818283.
-
split()
La función split() divide una cadena de entrada en varias listas dependiendo de los separadores especificados. Si no se especifica ningún separador o en blanco (''), esta función considera el espacio como un separador y divide la cadena en listas.
Ejemplos:
-
La función
split('Example_string_split', 's')devuelve['Example_','tring_','plit']. -
La función
split('Example string split')devuelve['Example','string','split']. -
La función
split('Example string split', '')devuelve['Example','string','split']. -
La función
split('Example string')devuelve['Example','string'].Esta función considera los espacios continuos como un espacio.
map()
La función map() toma dos argumentos;
Argumento 1: Cualquier función
Argumento 2: Una lista de elementos.
La función devuelve una lista donde cada elemento de la lista es el resultado de aplicar la map() función (argumento uno) al elemento correspondiente en el argumento dos.
Funciones permitidas en el argumento 1:
-
Funciones integradas que toman un argumento:
base64.encode, base64.decode, bin, bool, exists, hex, int, ip, len, lower, upper, oct, quotewrap, str, trim, upper, url.encode, url.decode -
Funciones de sustitución que toman al menos un argumento.
Ejemplo:
Supongamos que $parameters.nums lo es [81, 82, 83].
-
Mapa mediante una función integrada, str
La función
map(str, $parameters.nums)devuelve["81", "82", "83"]El resultado de la función de mapa es la lista de cadenas donde cada elemento es cadena se calcula aplicando la función str en el elemento correspondiente en la lista de entrada ($parameters.nums).
-
Mapear mediante una función de sustitución
-
Sustituciones:
add-10(port): $port + 10 -
Expresión :
La función
map($substitutions.add-10, $parameters.nums)devuelve una lista de números:[ 91, 92, 93 ]
-
El resultado de esta función de mapa es una lista de números, cada elemento se calcula aplicando la función de sustitución $substitutions.add-10 en el elemento correspondiente en la lista de entrada ($parameters.nums).
quotewrap()
La función quotewrap() toma una cadena como argumento y devuelve una cadena después de agregar un carácter de comilla doble antes y después del valor de entrada.
Ejemplo:
La función quotewrap("ADM") devuelve "mas"
replace()
La función replace() toma tres argumentos:
Argumento 1: cadena
Argumento 2: cadena o lista
Argumento 3: cadena (opcional)
La función reemplaza todas las apariciones del argumento dos por el argumento tres en el argumento uno.
Si no se proporciona el argumento tres, todas las apariciones del argumento dos se eliminan del argumento uno (en otras palabras, se reemplazan con una cadena vacía).
Reemplazar una subcadena por otra subcadena:
-
La
replace('abcdef', 'def', 'xyz')función devuelveabcxyz.Todas las ocurrencias de
defse reemplazan porxyz. -
replace('abcdefabc', 'def')devuelveabcabc.Como no hay un tercer argumento,
defse elimina de la cadena resultante.
Especifique la lista de caracteres que quiere reemplazar en una cadena.
$parameters.spl_chars = ['@', '#', '!', '%']
Esta lista contiene los valores que deben reemplazarse en una cadena de entrada.
La replace('An#example@to%replace!characters', $parameters.spl_chars, '_') función devuelve An_example_to_replace_characters.
La cadena de salida tiene guión bajo (_) en lugar de caracteres especificados en la lista $parameters.spl_chars.
trim()
La función trim() devuelve una cadena donde los espacios en blanco iniciales y finales se eliminan de la cadena de entrada.
Ejemplo:
La función trim(' abc ') devuelve abc.
truncate()
La función truncate() toma dos argumentos:
Argumento 1: cadena
Argumento 2: número
La función devuelve una cadena en la que la cadena de entrada del argumento uno se trunca a la longitud especificada por el argumento dos.
Ejemplo:
truncate('NetScaler ADM', 6) devuelve Citrix.
distinct()
La función distinct() extrae elementos únicos de una entrada de lista.
Ejemplos:
Si $parameters.input_list es ['ADM', 'ADC', 'VPX', 'ADC', 'ADM', 'CPX'], la función distinct($parameters.input_list) devuelve ['ADM', 'ADC', 'VPX', 'CPX'].
url.encode()
La función url.encode() devuelve una cadena donde los caracteres se transforman mediante el juego de caracteres ASCII de acuerdo con RFC 3986.
Ejemplo:
La función url.encode("a/b/c") devuelve a%2Fb%2Fc.
url.decode()
La función url.decode() devuelve una cadena donde el argumento codificado URL se decodifica en una cadena regular de acuerdo con RFC 3986.
Ejemplo:
La función url.decode("a%2Fb%2Fc") devuelve a/b/c.
is-ipv4()
La función is-ipv4() toma una dirección IP como argumento y devuelve el booleano True si la dirección IP es del formato IPv4.
La función is-ipv4(10.10.10.10) devuelve True
is-ipv6()
La función is-ipv6() toma una dirección IP como argumento y devuelve el booleano True si la dirección IP es del formato IPv6.
La función is-ipv6(2001:DB8::) devuelve True
startswith()
La función startswith() determina si una cadena comienza con un prefijo dado. Esta función requiere dos argumentos de cadena obligatorios.
startswith(str, sub_str)
Esta función devuelve True cuando la cadena (str) comienza con la subcadena (sub_str).
Ejemplos:
- La función
startswith('Citrix', 'Ci')devuelveTrue. - La función
startswith('Citrix', 'iC')devuelveFalse - La función
startswith('Citrix', 'Ab')devuelveFalse
endswith()
La función endswith() determina si una cadena termina con un sufijo dado. Esta función requiere dos argumentos de cadena obligatorios.
endswith(str, sub_str)
Esta función devuelve True cuando la cadena (str) termina con la subcadena (sub_str).
Ejemplos:
- La función
endswith('Citrix', 'ix')devuelveTrue. - La función
endswith('Citrix', 'Ix')devuelveFalse. - La función
endswith('Citrix', 'ab')devuelveFalse.
contains()
La función contains() determina si una cadena contiene una subcadena dada. Esta función requiere dos argumentos de cadena obligatorios.
contains(str, sub_str)
Esta función devuelve True cuando la subcadena (sub_str) está contenida en cualquier lugar dentro de la cadena (str).
Ejemplo :
- La
contains('Citrix', 'tri')función devuelveTrue. - La función
contains('Citrix', 'Ci')devuelveTrue. - La
contains('Citrix', 'ti')función devuelveFalse
substring()
Utilice la función substring() para extraer una subcadena de una cadena.
substring(str, start_index, end_index)
Esta función requiere los dos argumentos obligatorios y un argumento entero opcional.
-
str(Obligatorio) -
start_index(Obligatorio) -
end_index(Opcional)
Esta función devuelve la subcadena de la cadena (str) que se encuentra entre las posiciones de índice especificadas. Si no especifica la posición del índice final, la función extrae la subcadena desde el índice inicial hasta el final de la cadena.
Nota
Cuando se especifica
end_index, la subcadena excluye el carácter en la posiciónend_index.
Ejemplo :
-
La función
substring('Citrix', 2)devuelvetrix -
La función
substring('Citrix', 10)devuelve (")En este ejemplo, la función devuelve una cadena en blanco porque tiene una posición
start_indexno válida. -
La función
substring('Citrix', 2, 4)devuelvetrEn este ejemplo, la función extrae los caracteres entre 2 y 4 posiciones de índice.
-
La función
substring('Citrix', -3)devuelverixSi quiere extraer caracteres que están al final de la cadena, especifique un valor negativo para el argumento
start_index.En este ejemplo, la función extrae la subcadena que incluye los tres últimos caracteres de la cadena.
En este artículo
- str()
- int()
- bool()
- len()
- min()
- max()
- bin()
- oct()
- hex()
- lower()
- upper()
- sum()
- pow()
- ip()
- base64.encode()
- base64.decode()
- exists()
- filter()
- if-then-else()
- join()
- split()
- map()
- quotewrap()
- replace()
- trim()
- truncate()
- distinct()
- url.encode()
- url.decode()
- is-ipv4()
- is-ipv6()
- startswith()
- endswith()
- contains()
- substring()