組み込み関数
StyleBook の式では、組み込み関数を使用できます。
たとえば、組み込み関数
str() を使用して、数値を文字列に変換できます。
str($parameters.order)
または、組み込み関数
int() を使用して、文字列を整数に変換できます。
int($parameters.priority)
以下は、StyleBook の式でサポートされている組み込み関数と、その使用方法の例のリストです。
文字列()
str() 関数は、入力引数を文字列値に変換します。
許可される引数の型:
-
string -
number -
tcp-port -
boolean -
ipaddress
例:
-
"set-" + str(10)関数は"set-10"を返します。 -
str(10)関数は10を返します。 -
str(1.1.1.1)関数は1.1.1.1を返します。 -
str(True)関数は"True"を返します。 -
str(NetScaler Console)関数は"NetScaler Console"を返します。
int() 関数
int()関数は、文字列、数値、IPアドレス、またはtcpportを引数として受け取り、整数を返します。
例:
-
int("10")関数は10を返します。 -
int(10)関数は10を返します。 -
int(ip('0.0.4.1'))関数は1025を返します。
bool() 関数
bool()関数は任意の型を引数として受け取ります。引数値がfalse、空、または存在しない場合、この関数はfalseを返します。
それ以外の場合は、
trueを返します。
例:
-
bool(true)関数はtrueを返します。 -
bool(false)関数はfalseを返します。 -
bool($parameters.a)関数は、$parameters.aがfalse、空、または存在しない場合にfalseを返します。
長さ()
len()関数は、文字列またはリストを引数として受け取り、文字列内の文字数、またはリスト内の項目数を返します。
例 1:
置換を次のように定義した場合:
items: ["123", "abc", "xyz"]
len($substitutions.items)関数は3を返します
例 2:
len("NetScaler Console")関数は10を返します。
例 3:
$parameters.vipsに['1.1.1.1', '1.1.1.2', '1.1.1.3']の値がある場合、len($parameters.vips)関数は3を返します。
最小値()
min() 関数は、引数としてリストまたは一連の数値またはTCPポートを受け取り、最小の項目を返します。
数値/TCPポートの系列の例:
-
min(80, 100, 1000)関数は80を返します。 -
min(-20, 100, 400)関数は-20を返します。 -
min(-80, -20, -10)関数は-80を返します。 -
min(0, 100, -400)関数は-400を返します。
数値/TCPポートのリストの例:
-
サポート
$parameters.portsはTCPポートのリストであり、値は[80, 81, 8080]です。min($parameters.ports)関数は80を返します。
マックス()
max() 関数は、引数としてリストまたは一連の数値またはTCPポートを受け取り、最大の項目を返します。
数値/TCPポートの系列の例:
-
max(80, 100, 1000)関数は1000を返します。 -
max(-20, 100, 400)関数は400を返します。 -
max(-80, -20, -10)関数は-10を返します。 -
max(0, 100, -400)関数は100を返します。
数値/TCPポートのリストの例：
-
サポート
$parameters.portsはTCPポートのリストであり、値は[80, 81, 8080]です。max($parameters.ports)関数は8080を返します。
bin() 関数
bin()関数は数値を引数として受け取り、その数値をバイナリ形式で表す文字列を返します。
式の例：
bin(100)関数は0b1100100を返します。
oct() 関数
oct()関数は数値を引数として受け取り、その数値を8進数形式で表す文字列を返します。
式の例：
oct(100)関数は0144を返します。
hex() 関数
hex()関数は数値を引数として受け取り、その数値を16進数形式で表す小文字の文字列を返します。
式の例：
「
hex(100)」関数は「0x64」を返します。
lower() 関数
「
lower()」関数は文字列を引数として受け取り、その文字列を小文字で返します。
例:
「
lower("NetScaler Console")」関数は「NetScaler Console」を返します。
upper() 関数
「
upper()」関数は文字列を引数として受け取り、その文字列を大文字で返します。
例:
「
upper("NetScaler Console")」関数は「NetScaler Console」を返します。
sum() 関数
「
sum()」関数は数値のリストまたはtcpportsを引数として受け取り、リスト内の数値の合計を返します。
例 1:
置換を次のように定義した場合: substitutions:
list-of-numbers = [11, 22, 55]
「
sum($substitutions.list-of-numbers)」関数は「88」を返します。
例2:
$parameters.portsが[80, 81, 82]の場合、sum($parameters.ports)関数は243を返します。
pow() 関数
pow()関数は2つの数値を引数として受け取り、最初の引数を2番目の引数の累乗で表す数値を返します。
例:
pow(3,2)関数は9を返します。
ip()
ip()関数は、整数、文字列、またはIPアドレスを引数として受け取り、入力値に基づいてIPアドレスを返します。
例:
-
ip関数でIPアドレスを指定します。ip(3.1.1.1)関数は3.1.1.1を返します。 -
ip関数で文字列を指定します。ip('2.1.1.1')関数は2.1.1.1を返します -
ip関数で整数を指定します。-
ip(12)関数は0.0.0.12を返します。 -
ip関数で整数を文字列として指定すると、入力の同等のIPアドレスが返されます。ip('1025')関数は0.0.4.1を返します。
この関数は、整数の加算および減算操作もサポートしており、結果のIPアドレスを返します。-
加算:
ip(1025) + ip(12)関数は0.0.4.13を返します。 -
減算:
ip('1025') - ip(12)関数は0.0.3.245を返します。 -
加算と減算の組み合わせ:
ip('1.1.1.1') + ip('1.1.1.1') – ip(2)は2.2.2.0を返します。
-
ip_network()
ip_network関数は、IPアドレスとネットマスク長を引数として受け取り、IPネットワーク表記を返します。
例-1:
ip_network(1.1.1.1, 28)関数は1.1.1.1/28を返します。
例-2:
$parameters.ipaddrの値として1.1.1.1を考慮します。ip_network($parameters.ipaddr, 30)関数は1.1.1.1/30を返します。
例-3:
$parameters.netmask-lenの値として24を考慮します。ip_network(23.1.12.76, $parameters.netmask-len)関数は23.1.12.76/24を返します。
network_ip()
The
network_ip() 関数は、指定されたIPネットワークの最初のIPアドレスを返します。
例：
The
network_ip(1.1.1.1/28) 関数は 1.1.1.0 を返します。この例では、1.1.1.0 が指定されたネットワークの最初のIPアドレスです。
subnets() 関数
The
subnets() 関数は、指定されたIPネットワークとネットマスク長からサブネットのリストを返します。
例：
The
subnets(1.1.1.1/28, 30) 関数は、指定されたIPネットワークとネットマスク長からサブネットリストを返します。出力は次のようになります。
[1.1.1.0/30', '1.1.1.4/30', '1.1.1.8/30', '1.1.1.12/30']
netmask_ip()
The
netmask_ip() 関数は、指定されたIPネットワークのネットマスクIPアドレスを返します。
例：
The
netmask_ip(1.1.1.1/28) 関数は 255.255.255.240 を返します。指定されたIPネットワークの場合、255.255.255.240 がネットマスクIPアドレスです。
is_netmask_ip()
The
is_netmask_ip() 関数は入力として ipaddress を受け入れます。そして、指定された値が有効なネットマスクIPアドレスである場合、True を返します。
例 1：
「
is_netmask_ip(255.255.255.240) 関数は、指定された値が有効なネットマスクIPアドレスであるため、True を返します。」.
例 2:
「
is_netmask_ip(255.255.255.232) 関数は、指定された値が有効なネットマスクIPアドレスではないため、False を返します。」.
broadcast_ip()
「
broadcast_ip() 関数は、指定されたIPネットワークのブロードキャストIPアドレスを返します。」.
例:
「
broadcast_ip(1.1.1.1/28) 関数は 1.1.1.15 を返します。指定されたIPネットワークの場合、1.1.1.15 がブロードキャストIPアドレスです。」.
シーアイディーアール()
「
cidr() 関数は、指定されたIPネットワークのCIDR表記を返します。」.
例:
「
cidr(1.1.1.1/28) 関数は 1.1.1.0/28 を返します。指定されたIPネットワークの場合、1.1.1.0/28 がCIDR表記です。」.
is_cidr()
「
is_cidr() 関数は入力として ipnetwork を受け入れます。そして、指定された値がIPネットワークのCIDR表記と一致する場合、True を返します。」.
例-1:
「
is_cidr(1.1.1.0/24) 関数は、指定された値が与えられたネットワークのCIDR表記であるため、True を返します。」.
例-2:
is_cidr(1.1.1.1/28)関数は、指定されたネットワークのCIDR表記が指定された値と異なるため、Falseを返します。
is_in_network()
is_in_network()関数はipnetworkとipaddressの値を受け入れます。そして、指定されたIPアドレスが指定されたIPネットワーク内に存在する場合、Trueを返します。
例-1:
is_in_network(1.1.1.1/24, 1.1.1.121)関数は、1.1.1.121アドレスが1.1.1.1/24ネットワークの一部であるため、Trueを返します。
例-2:
is_in_network(1.1.1.1/28, 2.1.1.1)関数は、2.1.1.1アドレスが1.1.1.1/28ネットワークの一部ではないため、Fasleを返します。
base64.encode()
base64.encode()関数は文字列引数を受け取り、base64エンコードされた文字列を返します。
例:
base64.encode("abcd")関数はYWJjZA==を返します。
base64.decode()
base64.decode関数はbase64エンコードされた文字列を引数として受け取り、デコードされた文字列を返します。
例:
The
base64.decode("YWJjZA==") 関数は abcd を返します。
イグジスツ()
The
exists() 関数は任意の型の引数を取り、ブール値を返します。入力に何らかの値がある場合、戻り値は True です。入力引数に値がない場合（つまり、値がない場合）、戻り値は False です。
The
$parameters.monitor はオプションのパラメーターであるとします。設定パックを作成する際にこのパラメーターに値を指定すると、($parameters.monitor) 関数は True を返します。
そうでない場合、
False を返します。
フィルター()
The
filter() 関数は2つの引数を取ります。
引数1：1つの引数を取り、ブール値を返す置換関数。
引数2：リスト。
この関数は、各要素が
True と評価される元のリストのサブセットを返します。最初の 引数にある置換関数に渡されたときに。
例:
置換関数を次のように定義したとします。
置換:
x(a): $a != 81
この関数は、入力値が
81 と等しくない場合、True を返します。そうでない場合、False を返します。
仮に、
$parameters.portsが[81, 80, 81, 89]であるとします。
filter($substitutions.x, $parameters.ports)は、リストから81のすべての出現箇所を削除して、[80, 89]を返します。
イフ・ゼン・エルス()
関数
if-then-else()は3つの引数を取ります。
引数1：ブール式
引数2：任意の式
引数3：任意の式（オプション）
引数1の式が
Trueと評価される場合、関数は引数2として提供された式の値を返します。
それ以外の場合、引数3が指定されている場合、関数は引数3の式の値を返します。
引数3が指定されていない場合、関数は
noを返します。
例1：
$parameters.servicetypeの値がHTTPの場合、if-then-else($parameters.servicetype == HTTP, 80, 443)関数は80を返します。それ以外の場合、関数は443を返します。
例2：
$parameters.servicetypeの値がHTTPの場合、if-then-else($parameters.servicetype == HTTP, $parameters.hport, $parameters.sport)関数は$parameters.hportの値を返します。
それ以外の場合、関数は
$parameters.sportの値を返します。
例 3:
$parameters.servicetypeがHTTPの値を持つ場合、if-then-else($parameters.servicetype == HTTP, 80)は80を返します。
それ以外の場合、関数は値を返しません。
join() 関数
join()関数は2つの引数を取ります。
引数1：
number、tcp-port、string、ipaddressのリスト
引数2：区切り文字列 (オプション)
この関数は、引数1として提供されたリストの要素を文字列に結合します。各要素は、引数2として提供された区切り文字列で区切られます。引数2が指定されていない場合、リスト内の要素は1つの文字列として結合されます。
例:
-
$parameters.portsは[81, 82, 83]です。-
区切り文字引数を使用した場合：
join($parameters.ports, '-')関数は81-82-83を返します。 -
区切り文字引数を使用しない場合：
join($parameters.ports)関数は818283を返します。
-
split() 関数
split()関数は、指定された区切り文字に応じて入力文字列を複数のリストに分割します。区切り文字が指定されていないか、空白('')の場合、この関数はスペースを区切り文字と見なし、文字列をリストに分割します。
例:
-
split('Example_string_split', 's')関数は['Example_','tring_','plit']を返します。 -
split('Example string split')関数は['Example','string','split']を返します。 -
split('Example string split', '')関数は['Example','string','split']を返します。 -
split('Example string')関数は['Example','string']を返します。この関数は、連続するスペースを1つのスペースと見なします。
map() 関数
map()関数は2つの引数を取ります。
引数1：任意の関数
引数2：要素のリスト
この関数は、リストの各要素が、
map()関数（引数1）を引数2の対応する要素に適用した結果であるリストを返します。
引数1で許可される関数：
-
1つの引数を取る組み込み関数：
base64.encode, base64.decode, bin, bool, exists, hex, int, ip, len, lower, upper, oct, quotewrap, str, trim, upper, url.encode, url.decode -
少なくとも1つの引数を取る置換関数。
例:
$parameters.nums が
[81, 82, 83] であると仮定します。
-
組み込み関数 str を使用したマップ
map(str, $parameters.nums)関数は["81", "82", "83"]を返します。マップ関数の結果は文字列のリストであり、各要素は入力リスト ($parameters.nums) の対応する要素に str 関数を適用することによって計算されます。 -
置換関数を使用したマップ
-
置換:
add-10(port): $port + 10 -
式:
map($substitutions.add-10, $parameters.nums)関数は数値のリスト[ 91, 92, 93 ]を返します。
-
このマップ関数の結果は数値のリストです。各要素は、入力リスト
($parameters.nums) の対応する要素に置換関数 $substitutions.add-10 を適用することによって計算されます。
quotewrap() 関数
quotewrap() 関数は文字列を引数として受け取り、入力値の前後に二重引用符文字を追加した文字列を返します。
例:
「
quotewrap("NetScaler Console") 関数は "NetScaler Console" を返します。」
リプレース()
「
replace() 関数は3つの引数を取ります。」:
「引数1: 次の組み込み型の
string またはリスト」:
-
string -
number -
ipaddress -
tcp-port -
boolean
「引数2: 引数1で指定された型と一致する型の単一の値または値のリスト」
「引数3: 引数1で指定された型と同じ型の単一の値 (オプション)」
「
replace() 関数は、引数1内の引数2のすべての出現箇所を引数3に置き換えます。」.
「引数3が指定されていない場合、引数1から引数2のすべての出現箇所が削除されます。」.
例:
-
「
replace('abcdef', 'def', 'xyz')関数はabcxyzを返します。」.defのすべての出現箇所はxyzに置き換えられます。 -
replace('abcdefabc', 'def')はabcabcを返します。引数3がないため、defは結果の文字列から削除されます。 -
replace('An#example@to%replace!characters', ['@', '#', '!', '%'], '_')関数はAn_example_to_replace_charactersを返します。出力文字列には、['@', '#', '!', '%']で指定された文字の代わりにアンダースコア (_) が含まれます。 -
replace([10.10.10.1, 10.10.10.2, 10.10.10.3, 10.10.10.4], [10.10.10.2, 10.10.10.4])関数は[10.10.10.1, 10.10.10.3]を返します。引数3がないため、10.10.10.2と10.10.10.4は結果のIPアドレスリストから削除されます。 -
replace([8080, 8081, 8082, 8083, 8084], 8083, 80)関数は[8080, 8081, 8082, 80, 8084]を返します。8083のすべての出現箇所は80に置き換えられます。
トリム()
trim() 関数は、入力文字列から先頭と末尾の空白が削除された文字列を返します。
例：
trim(' abc ') 関数は abc を返します。
トランケート()
truncate() 関数は2つの引数を取ります。
引数 1: 文字列
引数 2: 数値
この関数は、引数 1 の入力文字列が引数 2 で指定された長さに切り詰められた文字列を返します。
例:
truncate('Stylebooks', 6) は Styleb を返します。
ディスティンクト()
distinct() 関数は、リスト入力から一意の項目を抽出します。
例:
$parameters.input_list が ['ADC', 'VPX', 'ADC', 'CPX'] の場合、distinct($parameters.input_list) 関数は ['ADC', 'VPX', 'CPX'] を返します。
url.encode()
url.encode() 関数は、RFC 3986 に従って ASCII 文字セットを使用して文字が変換された文字列を返します。
例:
url.encode("a/b/c") 関数は a%2Fb%2Fc を返します。
url.decode()
url.decode() 関数は、RFC 3986 に従って URL エンコードされた引数が通常の文字列にデコードされた文字列を返します。
例:
The
url.decode("a%2Fb%2Fc") 関数は a/b/c を返します。
イズ・アイピーブイフォー()
The
is-ipv4() 関数はIPアドレスを引数として受け取り、そのIPアドレスがIPv4形式である場合にブール値 True を返します。
The
is-ipv4(10.10.10.10) 関数は True を返します。
イズ・アイピーブイシックス()
The
is-ipv6() 関数はIPアドレスを引数として受け取り、そのIPアドレスがIPv6形式である場合にブール値 True を返します。
The
is-ipv6(2001:DB8::) 関数は True を返します。
startswith() 関数
The
startswith() 関数は、文字列が指定されたプレフィックスで始まるかどうかを判断します。この関数には、2つの必須文字列引数が必要です。
startswith(str, sub_str)
この関数は、文字列 (
str) が部分文字列 (sub_str) で始まる場合に True を返します。
例:
-
The
startswith('Citrix', 'Ci')関数はTrueを返します。 -
The
startswith('Citrix', 'iC')関数はFalseを返します。 -
The
startswith('Citrix', 'Ab')関数はFalseを返します。
endswith() 関数
endswith()関数は、文字列が指定されたサフィックスで終わるかどうかを判断します。この関数は、2つの必須文字列引数を必要とします。
endswith(str, sub_str)
文字列 (
str) が部分文字列 (sub_str) で終わる場合、この関数はTrueを返します。
例:
-
endswith('Citrix', 'ix')関数はTrueを返します。 -
endswith('Citrix', 'Ix')関数はFalseを返します。 -
endswith('Citrix', 'ab')関数はFalseを返します。
コンテインズ()
contains()関数は、文字列が指定された部分文字列を含むかどうかを判断します。この関数は、2つの必須文字列引数を必要とします。
許可される引数タイプ:
-
string -
number -
tcp-port -
boolean -
ipaddress
contains(str, sub_str)
この関数は、文字列 (
str) 内にサブストリング (sub_str) が含まれている場合に True を返します。
例:
-
contains('Citrix', 'tri')関数はTrueを返します。 -
contains('Citrix', 'Ci')関数はTrueを返します。 -
contains('Citrix', 'ti')関数はFalseを返します。
この関数を使用して、特定の項目がリストに属しているかどうかを確認することもできます。
例:
list_of_strings = [“Citrix”, “Core”, ”Values”, ”Integrity”]
contains($parameters.list_of_strings, “Values”)
この例では、リストに
Values 項目が含まれているため、contains() 関数は True を返します。
substring() 関数
文字列からサブストリングを抽出するには、
substring() 関数を使用します。
substring(str, start_index, end_index)
この関数には、2つの必須引数と1つのオプションの整数引数が必要です。
-
str(必須) -
start_index(必須) -
end_index(任意)
この関数は、指定されたインデックス位置の間にある文字列 (
str) からサブストリングを返します。終了インデックス位置を指定しない場合、関数は開始インデックスから文字列の末尾までサブストリングを抽出します。
注
end_index を指定すると、サブストリングは end_index の位置にある文字を除外します。
例:
-
substring('Citrix', 2)関数はtrixを返します -
substring('Citrix', 10)関数は (") を返しますこの例では、無効なstart_index位置があるため、関数は空の文字列を返します。 -
substring('Citrix', 2, 4)関数はtrを返しますこの例では、関数はインデックス位置 2 と 4 の間の文字を抽出します。 -
substring('Citrix', -3)関数はrixを返します文字列の末尾にある文字を抽出したい場合は、start_index引数に負の値を指定します。この例では、関数は文字列の最後の3文字を含むサブストリングを抽出します。
マッチ()
match() 関数は、入力文字列が定義された正規表現パターンと一致するかどうかをチェックします。この関数は、正規表現パターンと検索文字列を引数として受け入れます。オプションで、大文字と小文字を区別するパターンを無視するためにブール型を指定することもできます。
例：
-
match(“\^[A-Z0-9]{2}_[A-Z0-9]{2,10}$”, “A2_B2”)はTrueを返します。 -
match(“\^[A-Z0-9]{2}_[A-Z0-9]{2,10}$”, “a2_b2”)はFalseを返します。 -
match(“\^[A-Z0-9]{2}_[A-Z0-9]{2,10}$”, “a2_B2”, $parameters.ignore_case)はTrueを返します。
sha256()
この関数を使用して、任意の文字列のSHA-256ハッシュを計算します。この関数は、任意の長さの文字列入力を受け入れ、固定長（64文字）のハッシュ文字列を返します。
例：
components:
-
name: lbvserver-comp
type: ns::lbvserver
properties:
name: sha256(lbserver-name)
servicetype: SSL
ipv46: 10.10.10.10
この例では、
lbserver-name はNetScalerオブジェクト上でハッシュ文字列として表示されます。
この関数は、式を入力として受け入れることもできます。
例：
components:
-
name: lbvserver-comp
type: ns::lbvserver
properties:
name: sha256($parameters.lb-appname)
servicetype: SSL
ipv46: 10.10.10.10
リレート()
relate() 関数は、一連のリストから辞書オブジェクトのリストを形成します。
2つの引数を取ります。
引数1：キー名を表す文字列のリスト。
引数2：リストのリスト。各リストには、引数1の対応するキー名の値が含まれます。引数2の各リストは同じ長さである必要があります。引数2のリストの数は、引数1の文字列の数と等しくなければなりません。
例:
name: test_relate_3
description: "Hello World StyleBook."
namespace: com.citrix.adc.stylebooks
schema-version: "1.0"
version: "1.1"
import-stylebooks:
-
namespace: netscaler.nitro.config
prefix: ns
version: "10.5"
-
namespace: com.citrix.adc.stylebooks
prefix: stlb
version: "1.0"
parameters:
-
name: namesofservers
description: "Provide the names of LB VServers"
type: string[]
-
name: listofips
description: "Provide the list of IP Addresses"
type: string[]
-
name: list_of_keys
type: string[]
default:
- "name"
- "ip"
substitutions:
list_of_values: [$parameters.namesofservers,$parameters.listofips]
components:
-
name: svc-comp
type: object
properties:
svcdetails: relate($parameters.list_of_keys,$substitutions.list_of_values)
-
name: lb-comp
type: ns::lbvserver
repeat: $components.svc-comp.properties.svcdetails
repeat-item: svcd
properties:
name: $svcd['name']
servicetype: HTTP
ipv46: $svcd['ip']
port: 80
この例では：
-
parametersセクションには、nameとipを持つlist_of_keysというリストがあります。 -
substitutionsセクションには、以下の2つのリストを持つlist_of_valuesというリストがあります。-
仮想サーバー名のリスト (
string) -
IPアドレスのリスト (
string)。
-
relate()組み込み関数は、list_of_keysとlist_of_valuesを引数として受け入れます。この関数は、各オブジェクトが最初のリストからの名前と2番目のリストからのIPアドレスを持つ辞書オブジェクトのリストを作成します。
以下の仮想サーバーのリストを提供する場合：
["lb1","lb2"]
および仮想サーバーIPアドレスのリストを次のように：
["1.1.1.1","2.2.3.3"]
relate()関数は、以下のリストを返します。
[\{"name": "lb1", "ip": "1.1.1.1"},\{"name": "lb2", "ip": "2.2.3.3"}]
StyleBookは、
componentsセクションで、この辞書オブジェクトのリストを反復処理して、対応する仮想サーバーを作成します。
マルチプル()
multiple()関数は2つの引数を取ります。
引数1：
number、string、boolean、ipaddress、tcp-port、またはpassword
引数 2:
number
multiple(argument1, argument2)関数は、引数1の多くのコピーを含むリストを返します。コピーの数は、引数2に渡された数と同じです。
例:
-
multiple(10.10.10.10, 3)関数は[10.10.10.10, 10.10.10.10, 10.10.10.10]を返します。 -
multiple(8080, 4)関数は[8080, 8080, 8080, 8080]を返します。
リバース()
reverse()関数は、項目のリストを引数として受け取り、同じ項目を逆順に並べたリストを返します。
引数には、次の組み込み型のリストを指定できます。
-
文字列
-
数値
-
IPアドレス
-
IPネットワーク
-
TCPポート
-
ブール値
-
パスワード
-
オブジェクト
-
ファイル
-
証明書ファイル
-
キーファイル
-
証明書キー
例: