0e5c71fb820e6509449e6ad21f0dbc3d4a384d93
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / readmes / README_ja_JP.md
1 # stdlib
2
3 #### 目次
4
5 1. [説明 - モジュールの機能とその有益性](#module-description)
6 1. [セットアップ - stdlib導入の基本](#setup)
7 1. [使用方法 - 設定オプションと追加機能](#usage)
8 1. [参考 - モジュールの機能と動作について](#reference)
9     1. [クラス](#classes)
10     1. [定義できるタイプ](#defined-types)
11     1. [データタイプ](#data-types)
12     1. [Facts](#facts)
13     1. [関数](#functions)
14 1. [制約事項 - OSの互換性など](#limitations)
15 1. [開発 - モジュール貢献についてのガイド](#development)
16 1. [コントリビュータ](#contributors)
17
18
19 ## モジュールの概要
20
21 このモジュールでは、Puppetモジュールリソースの標準ライブラリを提供しています。Puppetモジュールでは、この標準ライブラリを広く使用しています。stdlibモジュールは、以下のリソースをPuppetに追加します。
22
23  * ステージ
24  * Facts
25  * 関数
26  * 定義された型
27  * データタイプ
28  * プロバイダ
29
30 > *注:* バージョン3.7のPuppet Enterpriseには、stdlibモジュールが含まれていません。Puppet Enterpriseを使用している場合は、Puppetと互換性のあるstdlibの最新リリースをインストールする必要があります。
31
32 ## セットアップ
33
34 stdlibモジュールを[インストール](https://puppet.com/docs/puppet/latest/modules_installing.html)し、この標準ライブラリの関数、Facts、リソースをPuppetに追加します。
35
36 stdlibに依存するモジュールを記述する場合は、必ずmetadata.jsonで[依存関係を特定](https://puppet.com/docs/puppet/latest/modules_metadata.html#specifying-dependencies-in-modules)してください。
37
38 ## 使用方法
39
40 stdlibのほとんどの機能は、Puppetに自動的にロードされます。Puppetで標準化されたランステージを使用するには、`include stdlib`を用いてマニフェスト内でこのクラスを宣言してください。
41
42 宣言すると、stdlibがモジュール内の他のすべてのクラスを宣言します。現在モジュールに含まれている他のクラスは、`stdlib::stages`のみです。
43
44 `stdlib::stages`クラスは、インフラストラクチャ、言語ランタイム、アプリケーションレイヤの配備に関する各種のランステージを宣言します。ハイレベルステージは、以下のとおりです(順番どおり)。
45
46   * セットアップ
47   * main
48   * runtime
49   * setup_infra
50   * deploy_infra
51   * setup_app
52   * deploy_app
53   * deploy
54
55 使用例:
56
57 ```puppet
58 node default {
59   include stdlib
60   class { java: stage => 'runtime' }
61 }
62 ```
63
64 ## リファレンス
65
66 * [パブリッククラス](#public-classes)
67 * [プライベートクラス](#private-classes)
68 * [定義された型](#defined-types)
69 * [データタイプ](#data-types)
70 * [Facts](#facts)
71 * [関数](#functions)
72
73 ### クラス
74
75 #### パブリッククラス
76
77 `stdlib`クラスにはパラメータはありません。
78
79 #### プライベートクラス
80
81 * `stdlib::stages`: Puppetのランステージの標準セットを管理します。
82
83 ### 定義された型
84
85 #### `file_line`
86
87 任意の行がファイル内に確実に含まれるようにします。最初と最後の空白を含め、行全体をマッチさせます。その行が与えられたファイルに含まれない場合は、Puppetがファイルの最後にその行を追加し、望ましい状態を確保します。1つのファイル内で複数のリソースを宣言し、複数の行を管理することが可能です。
88
89 例:
90
91 ```puppet
92 file_line { 'sudo_rule':
93   path => '/etc/sudoers',
94   line => '%sudo ALL=(ALL) ALL',
95 }
96
97 file_line { 'sudo_rule_nopw':
98   path => '/etc/sudoers',
99   line => '%sudonopw ALL=(ALL) NOPASSWD: ALL',
100 }
101 ```
102
103 上の例では、指定された両方の行が、ファイル `/etc/sudoers`に確実に含まれます。
104
105 マッチ例:
106
107 ```puppet
108 file_line { 'bashrc_proxy':
109   ensure => present,
110   path   => '/etc/bashrc',
111   line   => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128',
112   match  => '^export\ HTTP_PROXY\=',
113 }
114 ```
115
116 上の例では、`match`により、'export'で始まり'HTTP_PROXY'と続く行が探され、その行が行内の値に置き換えられます。
117
118 マッチ例:
119
120 ```puppet
121 file_line { 'bashrc_proxy':
122   ensure             => present,
123   path               => '/etc/bashrc',
124   line               => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128',
125   match              => '^export\ HTTP_PROXY\=',
126   append_on_no_match => false,
127 }
128 ```
129
130 このコードの例では、`match`によってexportで始まり'HTTP_PROXY'が続く行が検索され、その行が行内の値に置き換えられます。マッチするものが見つからない場合、ファイルは変更されません。
131
132  `ensure => absent`の例:
133
134 `ensure => absent`を設定する場合に、このタイプの動作には2通りがあります。
135
136 1つは`match => ...`と`match_for_absence => true`の設定です。`match`により、'export'で始まり'HTTP_PROXY'と続く行が探され、その行が削除されます。複数の行がマッチし、`multiple => true`パラメータが設定されていない場合は、エラーが生じます。
137
138 この例で`line => ...`パラメータは承認されますが無視されます。
139
140 例: 
141
142 ```puppet
143 file_line { 'bashrc_proxy':
144   ensure            => absent,
145   path              => '/etc/bashrc',
146   match             => '^export\ HTTP_PROXY\=',
147   match_for_absence => true,
148 }
149 ```
150
151 `ensure => absent`を設定する場合のもう1つの動作は、`line => ...`の指定と一致なしです。行が存在しないことを確認した場合のデフォルトの動作では、マッチするすべての行を削除します。この動作を無効にすることはできません。
152
153 例: 
154
155 ```puppet
156 file_line { 'bashrc_proxy':
157   ensure => absent,
158   path   => '/etc/bashrc',
159   line   => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128',
160 }
161 ```
162
163
164 エンコード例:
165
166 ```puppet
167 file_line { "XScreenSaver":
168   ensure   => present,
169   path     => '/root/XScreenSaver'
170   line     => "*lock: 10:00:00",
171   match    => '^*lock:',
172   encoding => "iso-8859-1",
173 }
174 ```
175
176 ファイルにUTF-8に対応しない特殊文字が用いられていると、「Invalid byte sequence in UTF-8」(UTF-8で無効なバイト列)というエラーメッセージが表示されます。この場合は、ファイルエンコーディングを決定し、`encoding`属性で指定してください。
177
178 **Autorequire:** Puppetが管理しているファイルに、管理対象となる行が含まれている場合は、`file_line`リソースと当該ファイルの暗黙的な依存関係が設定されます。
179
180 **パラメータ** 
181
182 パラメータは、別途説明がない限り、すべてオプションです。
183
184 ##### `after`
185
186 このパラメータで指定された行の後に、Puppetが正規表現を用いて新規の行を追加します(既存の行が規定の位置に追加されます)。
187
188 値: 正規表現を含む文字列
189
190 デフォルト値: `undef`。
191
192 ##### `encoding`
193
194 適正なファイルエンコードを指定します。
195
196 値: 有効なRuby文字エンコードを指定する文字列
197
198 デフォルト: 'UTF-8'
199
200 ##### `ensure`: リソースが存在するかどうかを指定します。
201
202 値: 'present'、'absent'
203
204 デフォルト値: 'present'。
205
206 ##### `line`
207
208 **必須**
209
210 `path`パラメータにより位置を示されたファイルに追加する行を設定します。
211
212 値: 文字列
213
214 ##### `match`
215
216 ファイル内の既存の行と比較する正規表現を指定します。マッチが見つかった場合、新規の行を追加する代わりに、置き換えられます。
217
218 値: 正規表現を含む文字列
219
220 デフォルト値: `undef`。
221
222
223 ##### `match_for_absence`
224
225 `ensure => absent`の場合にマッチを適用するかどうかを指定します。`true`に設定してマッチを設定すると、マッチする行が削除されます。`false`に設定すると(デフォルト)、`ensure => absent`の場合にマッチが無視され、代わりに`line`の値が使用されます。`ensure => present`になっている場合は、このパラメータは無視されます。
226
227 ブーリアン。
228
229 デフォルト値: `false`。
230
231 ##### `multiple`
232
233 `match`および`after`により複数の行を変更できるかどうかを指定します。`false`に設定すると、file_lineは1つの行のみ置き換えることができますが、複数の行を置き換えようとするとエラーが発生します。`true`に設定すると、file_lineは1つまたは複数の行を置き換えることができます。
234
235 値: `true`、`false`。
236
237 デフォルト値: `false`。
238
239
240 ##### `name`
241
242 リソースの名称として使用する名前を指定します。リソースのnamevarをリソースの規定の`title`と異なるものにしたい場合は、`name`で名前を指定します。
243
244 値: 文字列
245
246 デフォルト値: タイトルの値
247
248 ##### `path`
249
250 **必須**
251
252 `line`で指定された行を確保するファイルを指定します。
253
254 値: 当該ファイルの絶対パスを指定する文字列
255
256 ##### `replace`
257
258 `match`パラメータとマッチする既存の行をリソースで上書きするかどうかを指定します。`false`に設定すると、`match`パラメータにマッチする行が見つかった場合、その行はファイルに配置されません。
259
260 `false`に設定すると、`match`パラメータにマッチする行が見つかった場合、その行はファイルに配置されません。
261
262 ブーリアン。
263
264 デフォルト値: `true`。
265
266 ##### `replace_all_matches_not_matching_line`
267
268 `line`がファイルにすでに存在する場合でも、`match`パラメータに一致するすべての行が置き換えられます。
269
270 デフォルト値: `false`。
271
272 ### データタイプ
273
274 #### `Stdlib::Absolutepath`
275
276 厳密な絶対パスタイプ。UnixpathタイプおよびWindowspathタイプの異形を使用します。
277
278 使用可能なインプット例:
279
280 ```shell
281 /var/log
282 ```
283
284 ```shell
285 /usr2/username/bin:/usr/local/bin:/usr/bin:.
286 ```
287
288 ```shell
289 C:\\WINDOWS\\System32
290 ```
291
292 使用不可能なインプット例:
293
294 ```shell
295 ../relative_path
296 ```
297
298 #### `Stdlib::Ensure::Service`
299
300 サービスリソースの使用可能なensure値と一致します。
301
302 使用可能なインプット例:
303
304 ```shell
305 stopped
306 running
307 ```
308
309 使用不可能なインプット例:
310
311 ```shell
312 true
313 false
314 ```
315
316 #### `Stdlib::Httpsurl`
317
318 HTTPS URLに一致します。この一致では、大文字と小文字は区別されません。
319
320 使用可能なインプット例:
321
322 ```shell
323 https://hello.com
324
325 HTTPS://HELLO.COM
326 ```
327
328 使用不可能なインプット例:
329
330 ```shell
331 httds://notquiteright.org`
332 ```
333
334 #### `Stdlib::Httpurl`
335
336 HTTPSとHTTPの両方のURLに一致します。この一致では、大文字と小文字は区別されません。
337
338 使用可能なインプット例:
339
340 ```shell
341 https://hello.com
342
343 http://hello.com
344
345 HTTP://HELLO.COM
346 ```
347
348 使用不可能なインプット例:
349
350 ```shell
351 httds://notquiteright.org
352 ```
353
354 #### `Stdlib::MAC`
355
356 [RFC5342](https://tools.ietf.org/html/rfc5342)で定義されるMACアドレスに一致します。
357
358 #### `Stdlib::Unixpath`
359
360 Unixオペレーティングシステムの絶対パスに一致します。
361
362 使用可能なインプット例:
363
364 ```shell
365 /usr2/username/bin:/usr/local/bin:/usr/bin:
366
367 /var/tmp
368 ```
369
370 使用不可能なインプット例:
371
372 ```shell
373 C:/whatever
374
375 some/path
376
377 ../some/other/path
378 ```
379
380 #### `Stdlib::Filemode`
381
382 1から4までの数字とシンボリックファイルモードからなる8進ファイルモードに一致します。
383
384 使用可能なインプット例:
385
386 ```shell
387 0644
388 ```
389
390 ```shell
391 1777
392 ```
393
394 ```shell
395 a=Xr,g=w
396 ```
397
398 使用不可能なインプット例:
399
400 ```shell
401 x=r,a=wx
402 ```
403
404 ```shell
405 0999
406 ```
407
408 #### `Stdlib::Windowspath`
409
410 Windowsオペレーティングシステムのパスに一致します。
411
412 使用可能なインプット例:
413
414 ```shell
415 C:\\WINDOWS\\System32
416
417 C:\\
418
419 \\\\host\\windows
420 ```
421
422 有効な値: Windowsのファイルパスに一致します。
423
424 #### `Stdlib::Filesource`
425
426 Puppetファイルタイプのソースパラメータの有効な値のパスに一致します。
427
428 使用可能なインプット例:
429
430 ```shell
431 http://example.com
432
433 https://example.com
434
435 file:///hello/bla
436 ```
437
438 有効な値: ファイルパス。
439
440 #### `Stdlib::Fqdn`
441
442 完全修飾ドメイン名(FQDN)のパスに一致します。
443
444 使用可能なインプット例:
445
446 ```shell
447 localhost
448
449 example.com
450
451 www.example.com
452 ```
453 有効な値: サーバーのドメイン名。
454
455 #### `Stdlib::Host`
456
457 有効なホストに一致します。これには、有効なipv4、ipv6、またはfqdnを含みます。
458
459 使用可能なインプット例:
460
461 ```shell
462 localhost
463
464 www.example.com
465
466 192.0.2.1
467 ```
468
469 有効な値: IPアドレスまたはドメイン名。
470
471 #### `Stdlib::Port`
472
473 有効なTCP/UDPポート番号に一致します。
474
475 使用可能なインプット例:
476
477 ```shell
478 80
479
480 443
481
482 65000
483 ```
484
485 有効な値: 整数。
486
487 #### `Stdlib::Port::Privileged`
488
489 有効なTCP/UDP特権ポート(1024未満)に一致します。
490
491 使用可能なインプット例:
492
493 ```shell
494 80
495
496 443
497
498 1023
499 ```
500
501 有効な値: 1024未満の数。
502
503 #### `Stdlib::Port::Unprivileged`
504
505 有効なTCP/UDP特権ポート(1024以上)に一致します。
506
507 使用可能なインプット例:
508
509 ```shell
510 1024
511
512 1337
513
514 65000
515
516 ```
517
518 有効な値: 1024以上の数。
519
520 #### `Stdlib::Base32`
521
522 有効なbase32文字列のパスに一致します。
523
524 使用可能なインプット例:
525
526 ```shell
527 ASDASDDASD3453453
528
529 asdasddasd3453453=
530
531 ASDASDDASD3453453==
532 ```
533
534 有効な値: base32文字列。
535
536 #### `Stdlib::Base64`
537
538 有効なbase64文字列のパスに一致します。
539
540 使用可能なインプット例:
541
542 ```shell
543 asdasdASDSADA342386832/746+=
544
545 asdasdASDSADA34238683274/6+
546
547 asdasdASDSADA3423868327/46+==
548 ```
549
550 有効な値: base64文字列。
551
552 #### `Stdlib::Ipv4`
553
554 有効なIPv4アドレスに一致します。
555
556 使用可能なインプット例:
557
558 ```shell
559 0.0.0.0
560
561 192.0.2.1
562
563 127.0.0.1
564 ```
565
566 有効な値: IPv4アドレス。
567
568 #### `Stdlib::Ipv6`
569
570 有効なIPv6アドレスに一致します。
571
572 使用可能なインプット例:
573
574 ```shell
575 2001:0db8:85a3:0000:0000:8a2e:0370:7334
576
577 2001:db8::
578
579 2001:db8::80
580 ```
581
582 有効な値: IPv6アドレス。
583
584 #### `Stdlib::Ip_address`
585
586 有効なIPv4またはIPv6アドレスに一致します。
587
588 使用可能なインプット例:
589
590 ```shell
591 0.0.0.0
592
593 127.0.0.1
594
595 fe80:0000:0000:0000:0204:61ff:fe9d:f156
596 ```
597
598 有効な値: IPアドレス。
599
600 #### `Stdlib::IP::Address`
601
602 IPv4とIPv6両方のアドレスを含む、任意のIPアドレスに一致します。CIDRフォーマットのIPv4アドレスで使用されるアドレスプレフィックスの有無に関わらず一致します。
603
604 例:
605
606 ```
607 '127.0.0.1' =~ Stdlib::IP::Address                                # true
608 '10.1.240.4/24' =~ Stdlib::IP::Address                            # true
609 '52.10.10.141' =~ Stdlib::IP::Address                             # true
610 '192.168.1' =~ Stdlib::IP::Address                                # false
611 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210' =~ Stdlib::IP::Address  # true
612 'FF01:0:0:0:0:0:0:101' =~ Stdlib::IP::Address                     # true
613 ```
614
615 #### `Stdlib::IP::Address::V4`
616
617 CIDRプレフィックスの有無に関わらず、ドット区切りの4つの10進数で表現されたIPv4アドレスで構成される任意の文字列に一致します。省略形(192.168.1など)には一致しません。省略形はドキュメンテーションが不十分で、サポートにばらつきがあるためです。
618
619 例:
620
621 ```
622 '127.0.0.1' =~ Stdlib::IP::Address::V4                                # true
623 '10.1.240.4/24' =~ Stdlib::IP::Address::V4                            # true
624 '192.168.1' =~ Stdlib::IP::Address::V4                                # false
625 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210' =~ Stdlib::IP::Address::V4  # false
626 '12AB::CD30:192.168.0.1' =~ Stdlib::IP::Address::V4                   # false
627 ```
628
629 有効な値: IPv4アドレス。
630
631 #### `Stdlib::IP::Address::V6`
632
633 アドレスプレフィックスの有無に関わらず、RFC 2373に規定された任意のフォーマットで記述されたIPv6アドレスを構成する任意の文字列に一致します。
634
635 例:
636
637 ```
638 '127.0.0.1' =~ Stdlib::IP::Address::V6                                # false
639 '10.1.240.4/24' =~ Stdlib::IP::Address::V6                            # false
640 'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210' =~ Stdlib::IP::Address::V6  # true
641 'FF01:0:0:0:0:0:0:101' =~ Stdlib::IP::Address::V6                     # true
642 'FF01::101' =~ Stdlib::IP::Address::V6                                # true
643 ```
644
645 有効な値: IPv6アドレス。
646
647 #### `Stdlib::IP::Address::Nosubnet`
648
649 `Stdlib::IP::Address`エイリアスと同じものに一致しますが、アドレスプレフィックスを含むアドレスには一致しません(たとえば、'192.168.0.6'には一致しますが、'192.168.0.6/24'には一致しません)。
650
651 有効な値: サブネットを持たないIPアドレス。
652
653 #### `Stdlib::IP::Address::V4::CIDR`
654
655 CIDR形式のIPv4アドレスに一致します。アドレスにアドレスプレフィックスが含まれている場合にのみ一致します(例えば、'192.168.0.6/24'には一致しますが、'192.168.0.6'には一致しません)。
656
657 有効な値: CIDRが提供されたIPv4アドレス、たとえば'192.186.8.101/105'など。これは、'192.186.8.101'~'192.168.8.105'を含むすべてに一致します。
658
659 #### `Stdlib::IP::Address::V4::Nosubnet`
660
661 アドレスプレフィックスを含まないIPv4アドレスに一致します(たとえば、'192.168.0.6'には一致しますが、'192.168.0.6/24'には一致しません)。
662
663 有効な値: サブネットを持たないIPv4アドレス。
664
665 #### `Stdlib::IP::Address::V6::Full`
666
667 [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt)の2.2に規定された「好ましい形式」のIPv6アドレスに一致します。[RFC 2373](https://www.ietf.org/rfc/rfc2373.txt)の2.3に規定されたアドレスプレフィックスの有無に関わらず一致します。
668
669 #### `Stdlib::IP::Address::V6::Alternate`
670
671 [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt)の2.2に規定された「代替形式」(最後の2つの16ビット断片をドット区切りの4つの10進数で表現できる)のIPv6アドレスに一致します。[RFC 2373](https://www.ietf.org/rfc/rfc2373.txt)の2.3に規定されたアドレスプレフィックスの有無に関わらず一致します。
672
673 #### `Stdlib::IP::Address::V6::Compressed`
674
675 [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt)の2.2に規定された0を圧縮する記法である`::`を含む可能性のあるIPv6アドレスに一致します。[RFC 2373](https://www.ietf.org/rfc/rfc2373.txt)の2.3に規定されたアドレスプレフィックスの有無に関わらず一致します。
676
677 #### `Stdlib::IP::Address::V6::Nosubnet`
678
679 `Stdlib::IP::Address::V6::Nosubnet::Full`、`Stdlib::IP::Address::V6::Nosubnet::Alternate`、および`Stdlib::IP::Address::V6::Nosubnet::Compressed`を許可するエイリアス。
680
681 #### `Stdlib::IP::Address::V6::Nosubnet::Full`
682
683 [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt)の2.2.1に規定された「好ましい形式」のIPv6アドレスに一致します。[RFC 2373](https://www.ietf.org/rfc/rfc2373.txt)の2.3に規定されたアドレスプレフィックスを持つアドレスには一致しません。
684
685 #### `Stdlib::IP::Address::V6::Nosubnet::Alternate`
686
687 [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt)の2.2.1に規定された「代替形式」(最後の2つの16ビット断片をドット区切りの4つの10進数で表現できる)のIPv6アドレスに一致します。[RFC 2373](https://www.ietf.org/rfc/rfc2373.txt)の2.3に規定されたアドレスプレフィックスを持たないアドレスにのみ一致します。
688
689 #### `Stdlib::IP::Address::V6::Nosubnet::Compressed`
690
691 [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt)の2.2.2に規定された0を圧縮する記法である`::`を含む可能性のあるIPv6アドレスに一致します。[RFC 2373](https://www.ietf.org/rfc/rfc2373.txt)の2.3に規定されたアドレスプレフィックスを持たないアドレスにのみ一致します。
692
693 ### Facts
694
695 #### `package_provider`
696
697 Puppetがこのシステムのパッケージ管理に使用するデフォルトのプロバイダを返します。
698
699 #### `is_pe`
700
701 Puppet Enterpriseがインストールされているかどうかを返します。PE 3.x以降のプラットフォームでは何も報告されません。
702
703 #### `pe_version`
704
705 インストールされているPuppet Enterpriseのバージョンを返します。PE 3.x以降のプラットフォームでは何も報告されません。
706
707 #### `pe_major_version`
708
709 インストールされているPuppet Enterpriseのメジャーバージョンを返します。PE 3.x以降のプラットフォームでは何も報告されません。
710
711 #### `pe_minor_version`
712
713 インストールされているPuppet Enterpriseのマイナーバージョンを返します。PE 3.x以降のプラットフォームでは何も報告されません。
714
715 #### `pe_patch_version`
716
717 インストールされているPuppet Enterpriseのパッチバージョンを返します。
718
719 #### `puppet_vardir`
720
721 PuppetまたはPuppet agentが稼働しているノードについて設定されたPuppet vardirの値を返します。
722
723 #### `puppet_environmentpath`
724
725 PuppetまたはPuppet agentが稼働しているノードについて設定されたPuppet環境の値を返します。
726
727 #### `puppet_server`
728
729 Puppet agentの`server`値を返します。この値は、agentが通信するPuppet masterのホストネームです。
730
731 #### `root_home`
732
733 ルートのホームディレクトリを決定します。
734
735 ルートのホームディレクトリを決定します。これは、オペレーティングシステムによって異なります。通常は'/root'です。
736
737 #### `service_provider`
738
739 Puppetがこのシステムのサービス管理に使用するデフォルトのプロバイダを返します。
740
741 ### 関数
742
743 #### `abs`
744
745 **非推奨:** この関数は、Puppet 6.0.0で、内蔵の[`abs`](https://puppet.com/docs/puppet/latest/function.html#abs)関数に置き換えられました。
746
747 数字の絶対値を返します。たとえば、'-34.56'は'34.56'になります。
748
749 引数: 整数値または浮動小数点値のいずれかの単一の引数。
750
751 *タイプ*: 右辺値
752
753 #### `any2array`
754
755 任意のオブジェクトを、そのオブジェクトを含む配列に変換します。空の引数リストは空の配列に変換されます。ハッシュは、キーと値が交互になった配列に変換されます。配列は変換されません。
756
757 Puppet 5.0.0以降では、タイプシステムを使用してほとんどすべてのデータタイプの新しい値を作成できます。内蔵の[`Array.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-array-and-tuple)関数を使用して新しい配列を作成できます。
758
759     $hsh = {'key' => 42, 'another-key' => 100}
760     notice(Array($hsh))
761
762 `[['key', 42], ['another-key', 100]]`を通知します
763
764 配列のデータタイプには、"まだ配列でない場合は配列を作成する"という特別なモードもあります。
765
766     notice(Array({'key' => 42, 'another-key' => 100}, true))
767
768 `true`フラグはハッシュが配列に変換されないようにするため、`[{'key' => 42, 'another-key' => 100}]`を通知します。
769
770 *タイプ*: 右辺値
771
772 #### `any2bool`
773
774 任意のオブジェクトをブーリアンに変換します。
775
776 * 'Y'、'y'、'1'、'T'、't'、'TRUE'、'yes'、'true'といった文字列は`true`を返します。
777 * '0'、'F'、'f'、'N'、'n'、'FALSE'、'no'、'false'といった文字列は`false`を返します。
778 * ブーリアンは元の値を返します。
779 * 0よりも大きい数字(または数字の文字列表現)は`true`を返します。それ以外は`false`を返します。
780 * undef値は`false`を返します。
781 * それ以外はすべて`true`を返します。
782
783 詳細については、内蔵の[`Boolean.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-boolean)を参照してください。
784
785 *タイプ*: 右辺値
786
787 #### `assert_private`
788
789 現在のクラスまたは定義をプライベートとして設定します。現在のモジュール外のクラスまたは定義タイプを呼び出すことはできません。
790
791 たとえば、クラス`foo::bar`で`assert_private()`がコールされると、クラスがモジュール`foo`の外から呼び出された場合、次のメッセージがアウトプットされます:`Class foo::bar is private`。
792
793 使用したいエラーメッセージを指定する方法:
794
795 ```puppet
796 assert_private("You're not supposed to do that!")
797 ```
798
799 *タイプ*: ステートメント
800
801 #### `base64`
802
803 文字列とbase64エンコードを相互に変換します。`action` ('encode'、'decode')とプレーンまたは base64でエンコードした`string`、およびオプションで`method` ('default'、'strict'、'urlsafe')が必要です。
804
805 下位互換性を得るには、`method`を`default`に設定します(指定されていない場合)。
806
807 > **注:** この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。
808
809 Puppet 4.8.0以降では、ベース64 でエンコードされた文字列の生成に、`バイナリ`データタイプを使用できます。
810
811 詳細については、内蔵の[`String.new`](https://puppet.com/docs/puppet/latest/function.html#binary-value-to-string)関数と[`Binary.new`](https://puppet.com/docs/puppet/latest/function.html#creating-a-binary)関数を参照してください。
812
813 バイナリ(非UTF-8)コンテンツを含むファイルの読み取りについては、内蔵の[`binary_file`](https://puppet.com/docs/puppet/latest/function.html#binary_file)関数を参照してください。
814
815     # encode a string as if it was binary
816     $encodestring = String(Binary('thestring', '%s'))
817     # decode a Binary assuming it is an UTF-8 String
818     $decodestring = String(Binary("dGhlc3RyaW5n"), "%s")
819
820 **例:**
821
822 ```puppet
823 base64('encode', 'hello')
824 base64('encode', 'hello', 'default')
825 # return: "aGVsbG8=\n"
826
827 base64('encode', 'hello', 'strict')
828 # return: "aGVsbG8="
829
830 base64('decode', 'aGVsbG8=')
831 base64('decode', 'aGVsbG8=\n')
832 base64('decode', 'aGVsbG8=', 'default')
833 base64('decode', 'aGVsbG8=\n', 'default')
834 base64('decode', 'aGVsbG8=', 'strict')
835 # return: "hello"
836
837 base64('encode', 'https://puppetlabs.com', 'urlsafe')
838 # return: "aHR0cHM6Ly9wdXBwZXRsYWJzLmNvbQ=="
839
840 base64('decode', 'aHR0cHM6Ly9wdXBwZXRsYWJzLmNvbQ==', 'urlsafe')
841 # return: "https://puppetlabs.com"
842 ```
843
844 *タイプ*: 右辺値
845
846 #### `basename`
847
848 パスの`basename`を返します。オプションの引数で拡張子が外れます。例:
849
850 ```puppet
851 basename('/path/to/a/file.ext')            => 'file.ext'
852 basename('relative/path/file.ext')         => 'file.ext'
853 basename('/path/to/a/file.ext', '.ext')    => 'file'
854 ```
855
856 *タイプ*: 右辺値
857
858 #### `bool2num`
859
860 ブーリアンを数字に変換します。以下の値を変換します。
861
862 * `false`、'f'、'0'、'n'、'no'を0に変換します。
863 * `true`、't'、'1'、'y'、'yes'を1に変換します。
864
865 引数: インプットとして、単一のブーリアンまたは文字列。
866
867 Puppet 5.0.0以降では、 タイプシステムを使用しているほとんどすべてのデータタイプに関して値を作成できます。内蔵の[`Numeric.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-numeric)、 [`Integer.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-integer)、および[`Float.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-float)
868 の各関数を使用して数値に変換できます。
869
870     notice(Integer(false)) # Notices 0
871     notice(Float(true))    # Notices 1.0
872
873 *タイプ*: 右辺値
874
875 #### `bool2str`
876
877 オプションで提供される引数を用いて、ブーリアンを文字列に変換します。オプションの第2および第3の引数は、trueおよびfalseがそれぞれ何に変換されるかを表しています。与えられた引数が1つだけの場合は、ブーリアンから`true`または`false`を含む文字列に変換されます。
878
879 *例:*
880
881 ```puppet
882 bool2str(true)                    => `true`
883 bool2str(true, 'yes', 'no')       => 'yes'
884 bool2str(false, 't', 'f')         => 'f'
885 ```
886
887 引数: ブーリアン。
888
889 Since Puppet 5.0.0, you can create new values for almost any
890 data type using the type system - you can use the built-in
891 [`String.new`](https://puppet.com/docs/puppet/latest/function.html#boolean-to-string)
892 function to convert to String, with many different format options:
893
894     notice(String(false))         # Notices 'false'
895     notice(String(true))          # Notices 'true'
896     notice(String(false, '%y'))   # Notices 'yes'
897     notice(String(true, '%y'))    # Notices 'no'
898
899 *タイプ*: 右辺値
900
901 #### `camelcase`
902
903 **非推奨:**この関数は、Puppet 6.0.0で、内蔵の[`camelcase`](https://puppet.com/docs/puppet/latest/function.html#camelcase)関数に置き換えられました。
904
905 配列内の1つの文字列またはすべての文字列の大文字と小文字の別をCamelCase(大小文字混在)に変換します。
906
907 引数: 配列または文字列のいずれか。受け取ったものと同じタイプの引数を返しますが、CamelCaseの形式で返します。
908
909 *注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。
910
911 *タイプ*: 右辺値
912
913 #### `capitalize`
914
915 **非推奨:**この関数は、Puppet 6.0.0で、内蔵の[`capitalize`](https://puppet.com/docs/puppet/latest/function.html#capitalize)関数に置き換えられました。
916
917 文字列または複数文字列の配列の最初の文字を大文字にし、各文字列の残りの文字を小文字にします。
918
919 引数: インプットとして、単一文字列または配列。*タイプ*: 右辺値
920
921 *注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。
922
923 #### `ceiling`
924
925 **非推奨:**この関数は、Puppet 6.0.0で、内蔵の[`ceiling`](https://puppet.com/docs/puppet/latest/function.html#ceiling)関数に置き換えられました。
926
927 引数以上の最小整数を返します。
928
929 引数: 単一の数値。
930
931 *タイプ*: 右辺値
932
933 #### `chomp`
934
935 **非推奨:**この関数は、Puppet 6.0.0で、内蔵の[`chomp`](https://puppet.com/docs/puppet/latest/function.html#chomp)関数に置き換えられました。
936
937 文字列または複数文字列の配列の最後から、レコード分離文字を削除します。たとえば、'hello\n'は'hello'になります。
938
939 引数: 単一の文字または配列。
940
941 *タイプ*: 右辺値
942
943 #### `chop`
944
945 **非推奨:**この関数は、Puppet 6.0.0で、内蔵の[`chop`](https://puppet.com/docs/puppet/latest/function.html#chop)関数に置き換えられました。
946
947 最後の文字を削除した新しい文字列を返します。文字列が'\r\n'で終わる場合は、両方の文字が削除されます。`chop`を空文字列に適用すると、空文字列が返されます。レコード分離文字のみを削除する場合は、`chomp`関数を使用してください。
948
949 引数: インプットとして、文字列または複数文字列の配列。
950
951 *タイプ*: 右辺値
952
953 #### `clamp`
954
955 整数値に基づく分類により、当該領域[Min、X、Max]内で値を維持します(パラメータの順序は関係ありません)。文字列が変換され、数字として比較されます。値の配列は、さらなる処理が可能なリストに平坦化されます。例:
956
957   * `clamp('24', [575, 187])`は187を返します。
958   * `clamp(16, 88, 661)`は88を返します。
959   * `clamp([4, 3, '99'])`は4を返します。
960
961 引数: 文字列、配列、数字。
962
963 Puppet 6.0.0以降では、内蔵の関数を使用して同じ結果を得ることができます。
964
965     [$minval, $maxval, $value_to_clamp].sort[1]
966
967 *タイプ*: 右辺値
968
969 #### `concat`
970
971 複数配列のコンテンツを、与えられた最初の配列に追加します。例:
972
973   * `concat(['1','2','3'],'4')`は['1','2','3','4']を返します。
974   * `concat(['1','2','3'],'4',['5','6','7'])`は['1','2','3','4','5','6','7']を返します。
975
976 Puppet 4.0以降では、配列の連結とハッシュのマージのために`+`演算子を使い、`<<`演算子を使って追加することができます。
977
978     ['1','2','3'] + ['4','5','6'] + ['7','8','9'] # returns ['1','2','3','4','5','6','7','8','9']
979     [1, 2, 3] << 4 # returns [1, 2, 3, 4]
980     [1, 2, 3] << [4, 5] # returns [1, 2, 3, [4, 5]]
981
982 *タイプ*: 右辺値
983
984 #### `convert_base`
985
986 与えられた整数または整数を表す10進数文字列を、指定した基数の文字列に変換します。例:
987
988   * `convert_base(5, 2)`は'101'になります。
989   * `convert_base('254', '16')`は'fe'になります。
990
991 Puppet 4.5.0以降では、内蔵の[`String.new`](https://puppet.com/docs/puppet/latest/function.html#integer-to-string)関数を使って、さまざまな形式のオプションでこれを行うことができます。
992
993     $binary_repr = String(5, '%b') # results in "101"
994     $hex_repr = String(254, '%x')  # results in "fe"
995     $hex_repr = String(254, '%#x') # results in "0xfe"
996
997 #### `count`
998
999 配列を最初の引数とオプションの2番目の引数と解釈します。
1000 2番目の引数に等しい配列内の要素の数をカウントします。
1001 配列のみで呼び出された場合は、nil/undef/empty-string以外の要素の数をカウントします。
1002
1003 > **注意**: 等値はRubyメソッドでテストされます。これはRubyが
1004 等値とみなす対象になります。文字列の場合、等値は大文字と小文字を区別します。
1005
1006 Puppetコアでは、 内蔵の
1007 [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) (Puppet 4.0.0以降)および
1008 [`length`](https://puppet.com/docs/puppet/latest/function.html#length) (Puppet 5.5.0以降、それ以前ではstdlib)の各関数の組み合わせを使用してカウントが行われます。
1009
1010 この例では、`undef`でない値のカウントを行う方法を示しています。
1011
1012     notice([42, "hello", undef].filter |$x| { $x =~ NotUndef }.length)
1013
1014 2を通知します。
1015
1016 *タイプ*: 右辺値
1017
1018 #### `deep_merge`
1019
1020 2つ以上のハッシュを再帰的に統合し、その結果得られたハッシュを返します。
1021
1022 ```puppet
1023 $hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } }
1024 $hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } }
1025 $merged_hash = deep_merge($hash1, $hash2)
1026 ```
1027
1028 得られるハッシュは、以下に相当します。
1029
1030 ```puppet
1031 $merged_hash = { 'one' => 1, 'two' => 'dos', 'three' => { 'four' => 4, 'five' => 5 } }
1032 ```
1033
1034 ハッシュである重複キーが存在する場合は、そうした重複キーが再帰的に統合されます。ハッシュではない重複キーが存在する場合は、最右のハッシュのキーが上位になります。
1035
1036 *タイプ*: 右辺値
1037
1038 #### `defined_with_params`
1039
1040 属性のリソースリファレンスとオプションでハッシュを取得します。特定の属性を持つリソースがすでにカタログに追加されている場合は`true`を返します。そうでない場合は`false`を返します。
1041
1042 ```puppet
1043 user { 'dan':
1044   ensure => present,
1045 }
1046
1047 if ! defined_with_params(User[dan], {'ensure' => 'present' }) {
1048   user { 'dan': ensure => present, }
1049 }
1050 ```
1051
1052 *タイプ*: 右辺値
1053
1054 #### `delete`
1055
1056 配列から任意の要素のインスタンスを、文字列からサブストリングを、またはハッシュからキーをすべて削除します。
1057
1058 例: 
1059
1060 * `delete(['a','b','c','b'], 'b')`は['a','c']を返します。
1061 * `delete('abracadabra', 'bra')`は'acada'を返します。
1062 * `delete({'a' => 1,'b' => 2,'c' => 3},['b','c'])`は{'a'=> 1}を返します。
1063 * `delete(['ab', 'b'], 'b')`は['ab']を返します。
1064
1065 Puppet 4.0.0以降では、マイナス(`-`)演算子によって、配列から値を削除し、ハッシュからキーを削除します。
1066
1067     ['a', 'b', 'c', 'b'] - 'b'
1068     # would return ['a', 'c']
1069
1070     {'a'=>1,'b'=>2,'c'=>3} - ['b','c'])
1071     # would return {'a' => '1'}
1072
1073 内蔵の
1074 [`regsubst`](https://puppet.com/docs/puppet/latest/function.html#regsubst)関数で、文字列からグローバル削除を実行できます。
1075
1076     'abracadabra'.regsubst(/bra/, '', 'G')
1077     #は、'acada'を返します。
1078
1079 通常、内蔵の
1080 [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) 関数によって、キーと値との組み合わせに基づき、配列とハッシュからエントリをフィルタリングできます。
1081
1082 *タイプ*: 右辺値
1083
1084 #### `delete_at`
1085
1086 決められたインデックス付き値を配列から削除します。
1087
1088 例: `delete_at(['a','b','c'], 1)`は['a','c']を返します。
1089
1090 Puppet 4以降では、内蔵の
1091 [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter)関数を使って、これを行うことができます。
1092
1093     ['a', 'b', 'c'].filter |$pos, $val | { $pos != 1 } # returns ['a', 'c']
1094     ['a', 'b', 'c', 'd'].filter |$pos, $val | { $pos % 2 != 0 } # returns ['b', 'd']
1095
1096 あるいは、配列の最初もしくは最後から、または両端から同時に削除したい場合は、スライス演算子`[ ]`を使用します。
1097
1098     $array[0, -1] # すべての値と同じ
1099     $array[2, -1] # 最初の2つの要素を除くすべて
1100     $array[0, -3] # 最後の2つの要素を除くすべて
1101
1102     $array[1, -2] # 最初と最後の要素を除くすべて
1103
1104
1105 *タイプ*: 右辺値
1106
1107 #### `delete_regex`
1108
1109 提示された正規表現にマッチする任意の要素のインスタンスを、配列またはハッシュからすべて削除します。文字列は1アイテム配列として処理されます。
1110
1111 *注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。
1112
1113
1114
1115
1116 * `delete_regex(['a','b','c','b'], 'b')`は['a','c']を返します。
1117 * `delete_regex({'a' => 1,'b' => 2,'c' => 3},['b','c'])`は{'a'=> 1}を返します。
1118 * `delete_regex(['abf', 'ab', 'ac'], '^ab.*')`は['ac']を返します。
1119 * `delete_regex(['ab', 'b'], 'b')`は['ab']を返します。
1120
1121 Puppet 4.0.0以降では、内蔵の[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter)関数で同等の処理を行います。
1122
1123     ["aaa", "aba", "aca"].filter |$val| { $val !~ /b/ }
1124     # ['aaa', 'aca']を返します
1125
1126 *タイプ*: 右辺値
1127
1128 #### `delete_values`
1129
1130 任意の値のインスタンスをハッシュからすべて削除します。
1131
1132 例: 
1133
1134 * `delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B')`は{'a'=>'A','c'=>'C','B'=>'D'}を返します。
1135
1136 Puppet 4.0.0以降では、内蔵の[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter)関数で同等の処理を行います。
1137
1138     $array.filter |$val| { $val != 'B' }
1139     $hash.filter |$key, $val| { $val != 'B' }
1140
1141 *タイプ*: 右辺値
1142
1143 #### `delete_undef_values`
1144
1145 `undef`値のインスタンスをアレイまたはハッシュからすべて削除します。
1146
1147 例: 
1148
1149 * `$hash = delete_undef_values({a=>'A', b=>'', c=>`undef`, d => false})`は{a => 'A', b => '', d => false}を返します。
1150
1151 Puppet 4.0.0以降では、内蔵の[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter)関数で同等の処理を行います。
1152
1153     $array.filter |$val| { $val =~ NotUndef }
1154     $hash.filter |$key, $val| { $val =~ NotUndef }
1155
1156 *タイプ*: 右辺値
1157
1158 #### `deprecation`
1159
1160 非推奨警告をプリントし、任意のキーについて警告を一度記録します:
1161
1162 ```puppet
1163 deprecation(key, message)
1164 ```
1165
1166 引数:
1167
1168 * キーを指定する文字列: Puppetプロセスの継続期間中にメッセージの数を少なく抑えるために、1つのキーにつき1つのメッセージのみを記録します。
1169 * メッセージを指定する文字列: 記録されるテキスト。
1170
1171 *タイプ*: ステートメント
1172
1173 **`deprecation`に影響を与える設定**
1174
1175 Puppetの他の設定は、stdlibの`deprecation`関数に影響を与えます。
1176
1177 * [`disable_warnings`](https://puppet.com/docs/puppet/latest/configuration.html#disablewarnings)
1178 * [`max_deprecations`](https://puppet.com/docs/puppet/latest/configuration.html#maxdeprecations)
1179 * [`strict`](https://puppet.com/docs/puppet/latest/configuration.html#strict):
1180
1181     * `error`: 非推奨メッセージにより、ただちに機能しなくなります。
1182     * `off`: メッセージがアウトプットされません。
1183     * `warning`: すべての警告を記録します。これがデフォルト設定です。
1184
1185 * 環境変数`STDLIB_LOG_DEPRECATIONS`
1186
1187   非推奨警告を記録するかどうかを指定します。これは特に、自動テストの際、移行の準備ができる前にログに情報が氾濫するのを避けるうえで役立ちます。
1188
1189   この変数はブーリアンで、以下の効果があります:
1190
1191   * `true`: 警告を記録します。
1192   * `false`: 警告は記録されません。
1193   * 値を設定しない場合: Puppet 4は警告を出しますが、Puppet 3は出しません。
1194
1195 #### `difference`
1196
1197 2つの配列の間の差異を返します。返される配列はオリジナル配列のコピーで、第2の配列にも見られるアイテムがあれば、それが取り除かれます。
1198
1199 例: 
1200
1201 * `difference(["a","b","c"],["b","c","d"])`は["a"]を返します。
1202
1203 Puppet 4以降では、Puppet言語のマイナス(`-`)演算子は同じことを行います。
1204
1205     ['a', 'b', 'c'] - ['b', 'c', 'd']
1206     # ['a']を返します
1207
1208 *タイプ*: 右辺値
1209
1210 #### `dig`
1211
1212 **非推奨:**この関数は、Puppet 4.5.0で、内蔵の[`dig`](https://puppet.com/docs/puppet/latest/function.html#dig)関数に置き換えられました。下位互換性を得るには、[`dig44()`](#dig44)を使用するか、新しいバージョンを使用してください。
1213
1214 パスを含むキー配列を通じて、複数レイヤーのハッシュおよびアレイ内の値を探します。この関数は各パスコンポーネントにより構造内を移動し、パスの最後で値を返すよう試みます。
1215
1216 この関数では、必要とされるパス引数に加え、デフォルトの引数を使用できます。パスが正しくない場合や、値が見つからない場合、その他のエラーが生じた場合は、デフォルトの引数を返します。
1217
1218 ```ruby
1219 $data = {
1220   'a' => {
1221     'b' => [
1222       'b1',
1223       'b2',
1224       'b3',
1225     ]
1226   }
1227 }
1228
1229 $value = dig($data, ['a', 'b', 2])
1230 # $value = 'b3'
1231
1232 # with all possible options
1233 $value = dig($data, ['a', 'b', 2], 'not_found')
1234 # $value = 'b3'
1235
1236 # using the default value
1237 $value = dig($data, ['a', 'b', 'c', 'd'], 'not_found')
1238 # $value = 'not_found'
1239 ```
1240
1241 1. **$data** 取り扱うデータ構造。
1242 2. **['a', 'b', 2]** パス配列。
1243 3. **'not_found'** デフォルト値。何も見つからない場合に返されます。
1244
1245 デフォルト値: `undef`。
1246
1247 *タイプ*: 右辺値
1248
1249 #### `dig44`
1250
1251 パスを含むキー配列を通じて、複数レイヤーのハッシュおよびアレイ内の値を探します。この関数は各パスコンポーネントにより構造内を移動し、パスの最後で値を返すよう試みます。
1252
1253 この関数では、必要とされるパス引数に加え、デフォルトの引数を使用できます。パスが正しくない場合や、値が見つからない場合、その他のエラーが生じた場合は、デフォルトの引数を返します。
1254
1255 ```ruby
1256 $data = {
1257   'a' => {
1258     'b' => [
1259       'b1',
1260       'b2',
1261       'b3',
1262     ]
1263   }
1264 }
1265
1266 $value = dig44($data, ['a', 'b', 2])
1267 # $value = 'b3'
1268
1269 # with all possible options
1270 $value = dig44($data, ['a', 'b', 2], 'not_found')
1271 # $value = 'b3'
1272
1273 # using the default value
1274 $value = dig44($data, ['a', 'b', 'c', 'd'], 'not_found')
1275 # $value = 'not_found'
1276 ```
1277
1278 *タイプ*: 右辺値
1279
1280 1. **$data** 取り扱うデータ構造。
1281 2. **['a', 'b', 2]** パス配列。
1282 3. **'not_found'** デフォルト値。何も見つからない場合に返されます。
1283    (オプション、デフォルトは`undef`)
1284
1285 #### `dirname`
1286
1287 パスの`dirname`を返します。たとえば、`dirname('/path/to/a/file.ext')`は'/path/to/a'を返します。
1288
1289 *タイプ*: 右辺値
1290
1291 #### `dos2unix`
1292
1293 与えられた文字列のUnixバージョンを返します。クロスプラットフォームテンプレートでファイルリソースを使用する場合に非常に役立ちます。
1294
1295 ```puppet
1296 file { $config_file:
1297   ensure  => file,
1298   content => dos2unix(template('my_module/settings.conf.erb')),
1299 }
1300 ```
1301
1302 [unix2dos](#unix2dos)も参照してください。
1303
1304 *タイプ*: 右辺値
1305
1306 #### `downcase`
1307
1308 **非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`downcase`](https://puppet.com/docs/puppet/latest/function.html#downcase)関数に置き換えられました。
1309
1310 配列内の1つの文字列またはすべての文字列の大文字と小文字の別を、小文字に変換します。
1311
1312 *注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。
1313
1314 *タイプ*: 右辺値
1315
1316 #### `empty`
1317
1318 **非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`empty`](https://puppet.com/docs/puppet/latest/function.html#empty)関数に置き換えられました。
1319
1320 引数が要素を含まない配列かハッシュ、または空文字列である場合に、`true`を返します。引数が数値の場合に`false`を返します。
1321
1322 *タイプ*: 右辺値
1323
1324 #### `enclose_ipv6`
1325
1326 IPアドレスの配列を取得し、ipv6アドレスを大括弧でくくります。
1327
1328 *タイプ*: 右辺値
1329
1330 #### `ensure_packages`
1331
1332 配列またはハッシュ内のパッケージのリストを取得し、すでに存在しない場合にのみ、それらをインストールします。オプションで、ハッシュを第2のパラメータとして取得し、第3の引数として`ensure_resource()`または `ensure_resources()`関数に渡します。
1333
1334 *タイプ*: ステートメント
1335
1336 配列の場合:
1337
1338 ```puppet
1339 ensure_packages(['ksh','openssl'], {'ensure' => 'present'})
1340 ```
1341
1342 ハッシュの場合:
1343
1344 ```puppet
1345 ensure_packages({'ksh' => { ensure => '20120801-1' } ,  'mypackage' => { source => '/tmp/myrpm-1.0.0.x86_64.rpm', provider => "rpm" }}, {'ensure' => 'present'})
1346 ```
1347
1348 #### `ensure_resource`
1349
1350 リソースタイプ、タイトル、リソースを記述する属性のハッシュを取得します。
1351
1352 ```
1353 user { 'dan':
1354   ensure => present,
1355 }
1356 ```
1357
1358 この例では、すでに存在しない場合にのみリソースが作成されます:
1359
1360   `ensure_resource('user', 'dan', {'ensure' => 'present' })`
1361
1362 リソースがすでに存在しているものの、指定されたパラメータとマッチしない場合は、リソースの再作成が試みられ、重複リソース定義エラーにつながります。
1363
1364 リソースの配列を提示することも可能です。それぞれのリソースは、すでに存在しない場合に、指定のタイプおよびパラメータにより作成されます。
1365
1366 `ensure_resource('user', ['dan','alex'], {'ensure' => 'present'})`
1367
1368 *タイプ*: ステートメント
1369
1370 #### `ensure_resources`
1371
1372 ハッシュからリソース宣言を作成しますが、すでに宣言されているリソースとは対立しません。
1373
1374 リソースタイプ、タイトル、リソースを記述する属性のハッシュを指定します。
1375
1376 ```puppet
1377 user { 'dan':
1378   gid => 'mygroup',
1379   ensure => present,
1380 }
1381
1382 ensure_resources($user)
1383 ```
1384
1385 リソースのハッシュを提示します。リストにあるリソースは、すでに存在しない場合に、指定のタイプおよびパラメータにより作成されます。
1386
1387     ensure_resources('user', {'dan' => { gid => 'mygroup', uid => '600' } ,  'alex' => { gid => 'mygroup' }}, {'ensure' => 'present'})
1388
1389 Hieraバックエンドから:
1390
1391 ```yaml
1392 userlist:
1393   dan:
1394     gid: 'mygroup'
1395     uid: '600'
1396   alex:
1397     gid: 'mygroup'
1398 ```
1399
1400 ```puppet
1401 ensure_resources('user', hiera_hash('userlist'), {'ensure' => 'present'})
1402 ```
1403
1404 #### `fact`
1405
1406 指定されたfactの値を返します。構造化されたfactを参照する場合にドット表記を使用することができます。指定されたfactが存在しない場合は、Undefを返します。
1407
1408 使用例:
1409
1410 ```puppet
1411 fact('kernel')
1412 fact('osfamily')
1413 fact('os.architecture')
1414 ```
1415
1416 配列のインデックス: 
1417
1418 ```puppet
1419 $first_processor  = fact('processors.models.0')
1420 $second_processor = fact('processors.models.1')
1421 ```
1422
1423 名前に「.」を含むfact:
1424
1425 ```puppet
1426 fact('vmware."VRA.version"')
1427 ```
1428
1429 #### `flatten`
1430
1431 **非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`flatten`](https://puppet.com/docs/puppet/latest/function.html#flatten)関数に置き換えられました。
1432
1433 ネストの深いアレイを平坦化し、結果として単一のフラット配列を返します。
1434
1435 たとえば、`flatten(['a', ['b', ['c']]])`は['a','b','c']を返します。
1436
1437 *タイプ*: 右辺値
1438
1439 #### `floor`
1440
1441 **非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`floor`](https://puppet.com/docs/puppet/latest/function.html#floor)関数に置き換えられました。
1442
1443 引数以下の最大整数を返します。
1444
1445 引数: 単一の数値。
1446
1447 *タイプ*: 右辺値
1448
1449 #### `fqdn_rand_string`
1450
1451 ランダムな英数字文字列を生成します。`$fqdn` factとオプションのシードを組み合わせると、反復的な無作為抽出が可能です。オプションで、この関数に使用する文字セットを指定することもできます(デフォルトは英数字)。
1452
1453 *使用例:*
1454
1455 ```puppet
1456 fqdn_rand_string(LENGTH, [CHARSET], [SEED])
1457 ```
1458
1459 *例:*
1460
1461 ```puppet
1462 fqdn_rand_string(10)
1463 fqdn_rand_string(10, 'ABCDEF!@#$%^')
1464 fqdn_rand_string(10, '', 'custom seed')
1465 ```
1466
1467 引数:
1468
1469 * 整数、得られる文字列の長さを指定。
1470 * オプションで、文字セットを指定する文字列。
1471 * オプションで、反復的な無作為抽出を可能にするシードを指定する文字列。
1472
1473 *タイプ*: 右辺値
1474
1475 #### `fqdn_rotate`
1476
1477 配列と文字列をランダムな回数で回転させます。`$fqdn` factとオプションのシードを組み合わせると、反復的な無作為抽出が可能です。
1478
1479 *使用例:*
1480
1481 ```puppet
1482 fqdn_rotate(VALUE, [SEED])
1483 ```
1484
1485 *例:*
1486
1487 ```puppet
1488 fqdn_rotate(['a', 'b', 'c', 'd'])
1489 fqdn_rotate('abcd')
1490 fqdn_rotate([1, 2, 3], 'custom seed')
1491 ```
1492
1493 *タイプ*: 右辺値
1494
1495 #### `fqdn_uuid`
1496
1497 DNSネームスペースのFQDN文字列をもとに、[RFC 4122](https://tools.ietf.org/html/rfc4122)有効バージョン5 UUIDを返します:
1498
1499   * fqdn_uuid('puppetlabs.com')は'9c70320f-6815-5fc5-ab0f-debe68bf764c'を返します。
1500   * fqdn_uuid('google.com')は'64ee70a4-8cc1-5d25-abf2-dea6c79a09c8'を返します。
1501
1502 *タイプ*: 右辺値
1503
1504 #### `get_module_path`
1505
1506 現在の環境について、指定されたモジュールの絶対パスを返します。
1507
1508 ```puppet
1509 $module_path = get_module_path('stdlib')
1510 ```
1511
1512 Puppet 5.4.0以降では、内蔵の [`module_directory`](https://puppet.com/docs/puppet/latest/function.html#module_directory)関数は同じことを行い、複数の値または配列が与えられている場合、最初に見つかったモジュールへのパスを返します。
1513
1514 *タイプ*: 右辺値
1515
1516 #### `getparam`
1517 リソースのパラメータの値を返します。
1518
1519 引数: リソースリファレンスおよびパラメータの名前。
1520
1521 > 注意: ユーザ定義のリソースタイプは遅れて評価されます。
1522
1523 *例:*
1524
1525 ```puppet
1526 # define a resource type with a parameter
1527 define example_resource($param) {
1528 }
1529
1530 # declare an instance of that type
1531 example_resource { "example_resource_instance":
1532     param => "'the value we are getting in this example''"
1533 }
1534
1535 # Because of order of evaluation, a second definition is needed
1536 # that will be evaluated after the first resource has been declared
1537 #
1538 define example_get_param {
1539   # This will notice the value of the parameter
1540   notice(getparam(Example_resource["example_resource_instance"], "param"))
1541 }
1542
1543 # Declare an instance of the second resource type - this will call notice
1544 example_get_param { 'show_notify': }
1545 ```
1546
1547 'この例で取得している値'を通知します
1548
1549 Puppet 4.0.0以降では、データタイプ
1550 と[ ]演算子を使用してパラメータ値を取得できます。次の例は、getparam()の呼び出しと同じです。
1551
1552 ```puppet
1553 Example_resource['example_resource_instance']['param']
1554 ```
1555
1556 #### `getvar`
1557 **非推奨:** この関数は、Puppet 6.0.0で、内蔵の[`getvar`](https://puppet.com/docs/puppet/latest/function.html#getvar)
1558 関数に置き換えられました。新しいバージョンでも、構造化された値への掘り下げがサポートされます。
1559
1560 リモートネームスペースの変数を調べます。
1561
1562 例: 
1563
1564 ```puppet
1565 $foo = getvar('site::data::foo')
1566 # $foo = $site::data::fooと同等
1567 ```
1568
1569 この関数は、ネームスペースそのものが文字列に保存されている場合に役立ちます:
1570
1571 ```puppet
1572 $datalocation = 'site::data'
1573 $bar = getvar("${datalocation}::bar")
1574 # Equivalent to $bar = $site::data::bar
1575 ```
1576
1577 *タイプ*: 右辺値
1578
1579 #### `glob`
1580
1581 パスパターンに一致するパスの文字列配列を返します。
1582
1583 引数: パスパターンを指定する文字列または文字列配列。
1584
1585 ```puppet
1586 $confs = glob(['/etc/**/*.conf', '/opt/**/*.conf'])
1587 ```
1588
1589 *タイプ*: 右辺値
1590
1591 #### `grep`
1592
1593 配列内を検索し、提示された正規表現に一致する要素を返します。
1594
1595 たとえば、`grep(['aaa','bbb','ccc','aaaddd'], 'aaa')`は['aaa','aaaddd']を返します。
1596
1597 Puppet 4.0.0以降では、内蔵の[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter)関数は同じことを行います。正規表現とは対照的に、どのロジックでもフィルタリングに使用できます。
1598
1599     ['aaa', 'bbb', 'ccc', 'aaaddd']. filter |$x| { $x =~ 'aaa' }
1600
1601 *タイプ*: 右辺値
1602
1603 #### `has_interface_with`
1604
1605 種類および値に基づきブーリアンを返します:
1606
1607   * macaddress
1608   * netmask
1609   * ipaddress
1610   * network
1611
1612 *例:*
1613
1614 ```puppet
1615 has_interface_with("macaddress", "x:x:x:x:x:x")
1616 has_interface_with("ipaddress", "127.0.0.1")    => true
1617 ```
1618
1619 種類が提示されていない場合は、インターフェースの有無が確認されます:
1620
1621 ```puppet
1622 has_interface_with("lo")                        => true
1623 ```
1624
1625 *タイプ*: 右辺値
1626
1627 #### `has_ip_address`
1628
1629 一部のインターフェース上で、リクエストされたIPアドレスがクライアントに存在する場合は`true`を返します。この関数は`interfaces` factで反復され、`ipaddress_IFACE` factsをチェックし、簡単な文字列比較を実行します。
1630
1631 引数: IPアドレスを指定する文字列。
1632
1633 *タイプ*: 右辺値
1634
1635 #### `has_ip_network`
1636
1637 リクエストされたネットワーク内でIPアドレスがクライアントに存在する場合は`true`を返します。この関数は`interfaces` factで反復され、 `network_IFACE` factsをチェックし、簡単な文字列比較を実行します。
1638
1639 引数: IPアドレスを指定する文字列。
1640
1641 *タイプ*: 右辺値
1642
1643 #### `has_key`
1644 **非推奨:** この関数は、内蔵の`in`演算子に置き換えられました。
1645
1646 ハッシュに特定のキー値があるかどうかを判定します。
1647
1648 *例*:
1649
1650 ```
1651 $my_hash = {'key_one' => 'value_one'}
1652 if has_key($my_hash, 'key_two') {
1653   notice('we will not reach here')
1654 }
1655 if has_key($my_hash, 'key_one') {
1656   notice('this will be printed')
1657 }
1658 ```
1659
1660 Puppet 4.0.0以降では、これは、Puppet言語において、次の同等の式を用いて実現できます。
1661
1662     $my_hash = {'key_one' => 'value_one'}
1663     if 'key_one' in $my_hash {
1664       notice('this will be printed')
1665     }
1666
1667 *タイプ*: 右辺値
1668
1669 #### `hash`
1670
1671 **非推奨:** この関数は、ほとんどすべてのデータタイプの新しい値を作成する内蔵の機能に置き換えられました。
1672 Puppetに内蔵の[`Hash.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-hash-and-struct)関数を参照してください。
1673
1674 配列をハッシュに変換します。
1675
1676 例えば(非推奨)、`hash(['a',1,'b',2,'c',3])`は、 {'a'=>1,'b'=>2,'c'=>3}を返します。
1677
1678 例えば(内蔵)、`Hash(['a',1,'b',2,'c',3])`は、{'a'=>1,'b'=>2,'c'=>3}を返します。
1679
1680 *タイプ*: 右辺値
1681
1682 #### `intersection`
1683
1684 2つの共通部分の配列を返します。
1685
1686 たとえば、`intersection(["a","b","c"],["b","c","d"])`は["b","c"]を返します。
1687
1688 *タイプ*: 右辺値
1689
1690 #### `is_a`
1691
1692 ブーリアンチェックにより、変数が任意のデータタイプのものかどうかを判定します。これは`=~`タイプチェックに相当します。この関数はPuppet 4と、"future"パーサーを備えたPuppet 3でのみ使用できます。
1693
1694 ```
1695 foo = 3
1696 $bar = [1,2,3]
1697 $baz = 'A string!'
1698
1699 if $foo.is_a(Integer) {
1700   notify  { 'foo!': }
1701 }
1702 if $bar.is_a(Array) {
1703   notify { 'bar!': }
1704 }
1705 if $baz.is_a(String) {
1706   notify { 'baz!': }
1707 }
1708 ```
1709
1710 * タイプに関する詳細は、[Puppetタイプシステム](https://puppet.com/docs/puppet/latest/lang_data.html)を参照してください。
1711 * 値のタイプを特定する各種の方法については、[`assert_type()`](https://puppet.com/docs/puppet/latest/function.html#asserttype)関数を参照してください。
1712
1713 #### `is_absolute_path`
1714
1715 **非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。
1716
1717 与えられたパスが絶対パスである場合に`true`を返します。
1718
1719 *タイプ*: 右辺値
1720
1721 #### `is_array`
1722
1723 **非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。
1724
1725 この関数に渡された変数が配列である場合に`true`を返します。
1726
1727 *タイプ*: 右辺値
1728
1729 #### `is_bool`
1730
1731 **非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。
1732
1733 この関数に渡された変数がブーリアンである場合に`true`を返します。
1734
1735 *タイプ*: 右辺値
1736
1737 #### `is_domain_name`
1738
1739 **非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。
1740
1741 この関数に渡された文字列が構文的に正しいドメイン名である場合に`true`を返します。
1742
1743 *タイプ*: 右辺値
1744
1745 #### `is_email_address`
1746
1747 この関数に渡された文字列が有効なメールアドレスである場合にtrueを返します。
1748
1749 *タイプ*: 右辺値
1750
1751
1752 #### `is_float`
1753
1754 **非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。
1755
1756 この関数に渡された変数がフロート型である場合に`true`を返します。
1757
1758 *タイプ*: 右辺値
1759
1760 #### `is_function_available`
1761
1762 **非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。
1763
1764 文字列を引数として受け入れ、Puppetランタイムがその名前を用いて関数にアクセスできるかどうかを判定します。関数が存在する場合は`true`、存在しない場合は`false`を返します。
1765
1766 *タイプ*: 右辺値
1767
1768 #### `is_hash`
1769
1770 **非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。
1771
1772 この関数に渡された変数がハッシュである場合に`true`を返します。
1773
1774 *タイプ*: 右辺値
1775
1776 #### `is_integer`
1777
1778 **非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。
1779
1780 この文字列に返された変数が整数である場合に`true`を返します。
1781
1782 *タイプ*: 右辺値
1783
1784 #### `is_ip_address`
1785
1786 **非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。
1787
1788 この関数に渡された文字列が有効なIPアドレスである場合に`true`を返します。
1789
1790 *タイプ*: 右辺値
1791
1792 #### `is_ipv6_address`
1793
1794 **非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。
1795
1796 この関数に渡された文字列が有効なIPv6アドレスである場合に`true`を返します。
1797
1798 *タイプ*: 右辺値
1799
1800 #### `is_ipv4_address`
1801
1802 **非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。
1803
1804 この関数に渡された文字列が有効なIPv4アドレスである場合に`true`を返します。
1805
1806 *タイプ*: 右辺値
1807
1808 #### `is_mac_address`
1809
1810 この関数に渡された文字列が有効なMACアドレスである場合に`true`を返します。
1811
1812 *タイプ*: 右辺値
1813
1814 #### `is_numeric`
1815
1816 **非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。
1817
1818 この関数に渡された変数が数字である場合に`true`を返します。
1819
1820 *タイプ*: 右辺値
1821
1822 #### `is_string`
1823
1824 **非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。
1825
1826 この関数に渡された変数が文字列である場合に`true`を返します。
1827
1828 *タイプ*: 右辺値
1829
1830 #### `join`
1831
1832 **非推奨:** この関数は、Puppet 5.5.0で、内蔵の[`join`](https://puppet.com/docs/puppet/latest/function.html#join)関数に置き換えられました。
1833
1834 区切り文字を用いて、配列を文字列に結合します。たとえば、`join(['a','b','c'], ",")`は"a,b,c"になります。
1835
1836 *タイプ*: 右辺値
1837
1838 #### `join_keys_to_values`
1839
1840 区切り文字を用いて、ハッシュの各キーをそのキーに対応する値と結合し、結果を文字列として返します。
1841
1842 値が配列の場合は、キーは各要素の前に置かれます。返される値は、平坦化した配列になります。
1843
1844 たとえば、`join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ")`は["a is 1","b is 2","b is 3"]になります。
1845
1846 Puppet 5.0.0以降では、書式の制御が強化されています(インデントや改行、配列とハッシュエントリ、ハッシュエントリのキー/値の間の区切り、配列における値の個々の
1847 書式など)。内蔵の[`String.new`](https://docs.puppet.com/puppet/latest/function.html#conversion-to-string)関数、および`配列`と`ハッシュ`の書式設定オプションを参照してください。
1848
1849 *タイプ*: 右辺値
1850
1851 #### `keys`
1852
1853 **非推奨:** この関数は、Puppet 5.5.0で、内蔵の[`keys`](https://puppet.com/docs/puppet/latest/function.html#keys)関数に置き換えられました。
1854
1855 ハッシュのキーを配列として返します。
1856
1857 *タイプ*: 右辺値
1858
1859 #### `length`
1860
1861 **非推奨:** この関数は、Puppet 5.5.0で、内蔵の[`length`](https://puppet.com/docs/puppet/latest/function.html#length)関数に置き換えられました。
1862
1863 与えられた文字列、配列、ハッシュの長さを返します。廃止された`size()`関数に代わるものです。
1864
1865 *タイプ*: 右辺値
1866
1867 #### `loadyaml`
1868
1869 配列、文字列、ハッシュを含むYAMLファイルをロードし、対応するネイティブデータタイプでデータを返します。
1870
1871 例: 
1872
1873 ```puppet
1874 $myhash = loadyaml('/etc/puppet/data/myhash.yaml')
1875 ```
1876
1877 第2のパラメータは、ファイルが見つからなかった場合、または構文解析できなかった場合に返されます。
1878
1879 例: 
1880
1881 ```puppet
1882 $myhash = loadyaml('no-file.yaml', {'default'=>'value'})
1883 ```
1884
1885 *タイプ*: 右辺値
1886
1887 #### `loadjson`
1888
1889 配列、文字列、ハッシュを含むJSONファイルをロードし、対応するネイティブデータタイプでデータを返します。
1890
1891 例: 
1892
1893 最初のパラメータは、絶対ファイルパスまたはURLです。
1894
1895 ```puppet
1896 $myhash = loadjson('/etc/puppet/data/myhash.json')
1897 ```
1898
1899 第2のパラメータは、ファイルが見つからなかった場合、または構文解析できなかった場合に返されます。
1900
1901 例: 
1902
1903 ```puppet
1904   $myhash = loadjson('no-file.json', {'default'=>'value'})
1905   ```
1906
1907 *タイプ*: 右辺値
1908
1909 #### `load_module_metadata`
1910
1911 ターゲットモジュールのmetadata.jsonをロードします。モジュールのバージョンや、モジュールの動的サポートに関するオーサーシップの判定に使用できます。
1912
1913 ```puppet
1914 $metadata = load_module_metadata('archive')
1915 notify { $metadata['author']: }
1916 ```
1917
1918 モジュールのメタデータファイルが存在しない場合、カタログコンパイルに失敗します。これを避ける方法は、以下のとおりです:
1919
1920 ```
1921 $metadata = load_module_metadata('mysql', true)
1922 if empty($metadata) {
1923   notify { "このモジュールにはmetadata.jsonファイルがありません。": }
1924 }
1925 ```
1926
1927 *タイプ*: 右辺値
1928
1929 #### `lstrip`
1930
1931 **非推奨:** この関数は、Puppet 6.0.0で、内蔵の[`lstrip`](https://puppet.com/docs/puppet/latest/function.html#lstrip) 関数に置き換えられました。
1932
1933 文字列の左側のスペースを取り除きます。
1934
1935 *タイプ*: 右辺値
1936
1937 #### `max`
1938
1939 **非推奨:** この関数は、Puppet 6.0.0で、内蔵の[`max`](https://puppet.com/docs/puppet/latest/function.html#max) 関数に置き換えられました。
1940
1941 すべての引数の最大値を返します。少なくとも1つの引数が必要です。
1942
1943 引数: 数字または数字を表す文字列。
1944
1945 *タイプ*: 右辺値
1946
1947 #### `member`
1948
1949 変数が配列の構成要素かどうかを判定します。変数には文字列、配列、fixnumが使用できます。
1950
1951 たとえば、`member(['a','b'], 'b')`および`member(['a','b','c'], ['b','c'])`は`true`を返し、`member(['a','b'], 'c')`および`member(['a','b','c'], ['c','d'])`は`false`を返します。
1952
1953 *注*: この関数は、ネスト化した配列には対応していません。最初の引数にネスト化した配列が含まれている場合は、再帰的処理は行われません。
1954
1955 Puppet 4.0.0以降では、Puppet言語において同じことを実行できます。値が単一の場合には、
1956 `in`演算子を使用します。
1957
1958     'a' in ['a', 'b']  # true
1959
1960 また、配列の場合には、`-`演算子を使用してdiffを計算します。
1961
1962     ['d', 'b'] - ['a', 'b', 'c'] == []  # 'd'が減算されないため、false
1963     ['a', 'b'] - ['a', 'b', 'c'] == []  # 'a'と'b'の両方が減算されるため、true
1964
1965 また、Puppet 5.2.0以降では、配列やハッシュの内容をテストする一般的な形式は、内蔵されている[`any`](https://puppet.com/docs/puppet/latest/function.html#any)および[`all`](https://puppet.com/docs/puppet/latest/function.html#all)の各関数を使用することです。
1966
1967 *タイプ*: 右辺値
1968
1969 #### `merge`
1970
1971 2つ以上のハッシュを統合し、その結果得られたハッシュを返します。
1972
1973 *例*:
1974
1975 ```puppet
1976 $hash1 = {'one' => 1, 'two' => 2}
1977 $hash2 = {'two' => 'dos', 'three' => 'tres'}
1978 $merged_hash = merge($hash1, $hash2)
1979 # The resulting hash is equivalent to:
1980 # $merged_hash =  {'one' => 1, 'two' => 'dos', 'three' => 'tres'}
1981 ```
1982
1983 重複キーが存在する場合は、最右のハッシュのキーが上位になります。
1984
1985 Puppet 4.0.0以降では、+ 演算子を使用して同じマージを実行することができます。
1986
1987     $merged_hash = $hash1 + $hash2
1988
1989 *タイプ*: 右辺値
1990
1991 #### `min`
1992
1993 **非推奨:** この関数は、Puppet 6.0.0で、内蔵の[`min`](https://puppet.com/docs/puppet/latest/function.html#min)関数に置き換えられました。
1994
1995 すべての引数の最小値を返します。少なくとも1つの引数が必要です。
1996
1997 引数: 数字または数字を表す文字列。
1998
1999 *タイプ*: 右辺値
2000
2001 #### `num2bool`
2002
2003 数字または数字の文字列表現を正当なブーリアンに変換します。0または非数字は`false`になります。0より大きい数字は`true`になります。
2004
2005 Puppet 5.0.0以降では、タイプシステムを使用して同じことが行えます。
2006 利用可能な多くのタイプ変換については、Puppetの[`Boolean.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-boolean) 
2007 関数を参照してください。
2008
2009     Boolean(0) # false
2010     Boolean(1) # true
2011
2012 *タイプ*: 右辺値
2013
2014 #### `parsejson`
2015
2016 JSONの文字列を正確なPuppet構造に変換します(ハッシュ、配列、文字列、整数、またはそれらの組み合わせとして)。
2017
2018 引数:
2019 * 第1の引数として、変換されるJSON文字列。
2020 * オプションで、第2のエラーとして、変換に失敗した場合に返される結果。
2021
2022 *タイプ*: 右辺値
2023
2024 #### `parseyaml`
2025
2026 YAMLの文字列を正確なPuppet構造に変換します。
2027
2028 引数:
2029 * 第1の引数として、変換されるYAML文字列。
2030 * オプションで、第2のエラーとして、変換に失敗した場合に返される結果。
2031
2032 *タイプ*: 右辺値
2033
2034 #### `pick`
2035
2036 値のリストから、未定義または空文字列ではない最初の値を返します。引数から任意の数字をとり、すべての値が未定義または空の場合はエラーが生じます。
2037
2038 ```puppet
2039 $real_jenkins_version = pick($::jenkins_version, '1.449')
2040 ```
2041
2042 *タイプ*: 右辺値
2043
2044 #### `pick_default`
2045
2046 値のリストにある最初の値を返します。`pick()`関数とは異なり、`pick_default()`は、すべての引数が空の場合も失敗にはなりません。そのため、デフォルトとして空の値を使用できます。
2047
2048 *タイプ*: 右辺値
2049
2050 #### `prefix`
2051
2052 配列のすべての要素、またはハッシュのキーに接頭辞を適用します。
2053
2054 例: 
2055
2056 * `prefix(['a','b','c'], 'p')`は['pa','pb','pc']を返します。
2057 * `prefix({'a'=>'b','b'=>'c','c'=>'d'}, 'p')`は{'pa'=>'b','pb'=>'c','pc'=>'d'}を返します。
2058
2059 Puppet 4.0.0以降では、内蔵の[`map`](https://docs.puppet.com/puppet/latest/function.html#map)関数を使用して配列の値を変更します。
2060 この例は、上記の最初の例と同じです。
2061
2062         ['a', 'b', 'c'].map |$x| { "p${x}" }
2063
2064 *タイプ*: 右辺値
2065
2066 #### `pry`
2067
2068 現在のスコープオブジェクトでpryデバッグセッションを起動します。コンパイル中の特定ポイントにおけるマニフェストコードのデバッグに役立ちます。`puppet apply`の実行中またはフォアグラウンドでPuppet masterを実行しているときにのみ使用する必要があります。PuppetのRubyGemsに`pry` gemがインストールされている必要があります。
2069
2070 *例:*
2071
2072 ```puppet
2073 pry()
2074 ```
2075
2076 pryセッションで役立つコマンドは以下のとおりです:
2077
2078 * `catalog`を実行すると、現在カタログをコンパイルしているコンテンツを見られます。
2079 * `cd catalog`および`ls`を実行すると、カタログメソッドおよびインスタンス変数を見られます。
2080 * `@resource_table`を実行すると、現在のカタログリソーステーブルを見られます。
2081
2082 #### `pw_hash`
2083
2084 crypt関数を用いてパスワードをハッシュします。ほとんどのPOSIXシステムで使えるハッシュを提供します。
2085
2086 この関数の最初の引数は、ハッシュするパスワードです。`undef`または空文字列の場合は、この関数により`undef`が返されます。
2087
2088 この関数の第2の引数は、使用するハッシュのタイプです。適切なcrypt(3)ハッシュ指定子に変換されます。有効なハッシュタイプは以下のとおりです:
2089
2090 |ハッシュタイプ            |指定子|
2091 |---------------------|---------|
2092 |MD5                  |1        |
2093 |SHA-256              |5        |
2094 |SHA-512 (推奨)|6        |
2095
2096 この関数の第3の引数は、使用するソルトです。
2097
2098 この関数は、Puppet masterのcrypt(3)実装を使用しています。お使いの環境に複数の異なるオペレーティングシステムが含まれている場合は、この関数を使用する前に、互換性があることを確認してください。
2099
2100 *タイプ*: 右辺値
2101
2102 *注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。
2103
2104 #### `range`
2105
2106 '(start, stop)'の形式で与えられた場合に、領域を配列として外挿します。たとえば、`range("0", "9")`は[0,1,2,3,4,5,6,7,8,9]を返します。ゼロパディングされた文字列は、自動的に整数に変換されます。したがって、`range("00", "09")`は[0,1,2,3,4,5,6,7,8,9]を返します。
2107
2108 非整数文字列を使用できます:
2109
2110 * `range("a", "c")`は、["a","b","c"]を返します。
2111 * `range("host01", "host10")`は、["host01", "host02", ..., "host09", "host10"]を返します。
2112
2113 末尾のゼロを明示的に含める必要があります。そうでないと、下層のRuby関数が適切に機能しません。
2114
2115 第3の引数を渡すと、生成された領域がその間隔で刻まれます。例:
2116
2117 * `range("0", "9", "2")`は["0","2","4","6","8"]を返します。
2118
2119 > 注意: Puppet言語では、タイプシステムを使用して、`整数`と`フロート`の範囲をサポートしています。これらは、指定された回数の反復に適しています。
2120
2121 値のスキップについては、Puppetに内蔵の[`step`](https://docs.puppet.com/puppet/latest/function.html#step)関数を参照してください。
2122
2123    整数[0, 9]。それぞれの|$x| { notice($x) } #は、0, 1, 2, ... 9を通知します。
2124
2125 *タイプ*: 右辺値
2126
2127 #### `regexpescape`
2128
2129 文字列または文字列の配列を正規表現エスケープします。インプットとして、単一の文字列または配列のいずれかが必要です。
2130
2131 *タイプ*: 右辺値
2132
2133 #### `reject`
2134
2135 配列を検索し、提示された正規表現に一致する要素をすべてリジェクトします。
2136
2137 たとえば、`reject(['aaa','bbb','ccc','aaaddd'], 'aaa')`は['bbb','ccc']を返します。
2138
2139 Puppet 4.0.0以降では、Puppetに内蔵の[`filter`](https://docs.puppet.com/puppet/latest/function.html#filter)関数にも同じことが当てはまります。
2140 stdlibの`reject`関数に相当します。
2141
2142     ['aaa','bbb','ccc','aaaddd'].filter |$x| { $x !~ /aaa/ }
2143
2144 *タイプ*: 右辺値
2145
2146 #### `reverse`
2147
2148 文字列または配列の順序を逆転します。
2149
2150 > *注意*: Puppetでは、内蔵の[`reverse_each`](https://docs.puppet.com/puppet/latest/function.html#reverse_each)関数を使って同じことが行えます。
2151
2152
2153 #### `round`
2154
2155 **非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`round`](https://puppet.com/docs/puppet/latest/function.html#round)関数に置き換えられました。
2156
2157 数値を最も近い整数に丸めます。
2158
2159 *タイプ*: 右辺値
2160
2161 #### `rstrip`
2162
2163 **非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`rstrip`](https://puppet.com/docs/puppet/latest/function.html#`rstrip`)関数に置き換えられました。
2164
2165 文字列の右側のスペースを取り除きます。
2166
2167 *タイプ*: 右辺値
2168
2169 #### `seeded_rand`
2170
2171 整数の最大値と文字列のシード値を取り、最大値よりも小さい反復可能かつランダムな整数を返します。`fqdn_rand`と同様ですが、シードにノード固有のデータが追加されません。
2172
2173 *タイプ*: 右辺値
2174
2175 #### `seeded_rand_string`
2176
2177 (シード値に基づいて)一貫性のあるランダムな文字列を生成します。異なるホストに一致するパスワードを生成する場合に便利です。
2178
2179 #### `shell_escape`
2180
2181 文字列をエスケープし、Bourneシェルコマンドラインで安全に使用できるようにします。得られる文字列はクォートなしで使用する必要があり、ダブルクォートまたはシングルクォートでの使用は意図されていません。この関数は、Rubyの`Shellwords.shellescape()`関数と同様に挙動します。[Rubyドキュメント](http://ruby-doc.org/stdlib-2.3.0/libdoc/shellwords/rdoc/Shellwords.html#method-c-shellescape)を参照してください。
2182
2183 例: 
2184
2185 ```puppet
2186 shell_escape('foo b"ar') => 'foo\ b\"ar'
2187 ```
2188
2189 *タイプ*: 右辺値
2190
2191 #### `shell_join`
2192
2193 与えられた文字列の配列からコマンドライン文字列を構築します。各配列アイテムが、Bourneシェルで使用できるようにエスケープされます。その後、すべてのアイテムがまとめられ、間にシングルスペースが配されます。この関数は、Rubyの`Shellwords.shelljoin()`関数と同様に挙動します。[Rubyドキュメント](http://ruby-doc.org/stdlib-2.3.0/libdoc/shellwords/rdoc/Shellwords.html#method-c-shelljoin)を参照してください。
2194
2195 例: 
2196
2197 ```puppet
2198 shell_join(['foo bar', 'ba"z']) => 'foo\ bar ba\"z'
2199 ```
2200
2201 *タイプ*: 右辺値
2202
2203 #### `shell_split`
2204
2205 文字列をトークンの配列に分割します。この関数は、Rubyの`Shellwords.shellsplit()`関数と同様に挙動します。[Rubyドキュメント](http://ruby-doc.org/stdlib-2.3.0/libdoc/shellwords/rdoc/Shellwords.html#method-c-shellsplit)を参照してください。
2206
2207 *例:*
2208
2209 ```puppet
2210 shell_split('foo\ bar ba\"z') => ['foo bar', 'ba"z']
2211 ```
2212
2213 *タイプ*: 右辺値
2214
2215 #### `shuffle`
2216
2217 文字列または配列の順序をランダム化します。
2218
2219 *タイプ*: 右辺値
2220
2221 #### `size`
2222
2223 **非推奨:** この関数は、Puppet 6.0.0で、内蔵の[`size`](https://puppet.com/docs/puppet/latest/function.html#size) 関数に置き換えられました(`サイズ`は、`長さ`のエイリアスです)。
2224
2225 文字列、配列、ハッシュの要素数を返します。この関数は、今後のリリースでは廃止されます。Puppet 4では、`length`関数を使用してください。
2226
2227 *タイプ*: 右辺値
2228
2229 #### `sprintf_hash`
2230
2231 **非推奨:** Puppet 4.10.10および5.3.4では、内蔵の[`sprintf`](https://docs.puppet.com/puppet/latest/function.html#sprintf)関数を使って同じ機能を達成できます。この関数は、今後のリリースでは削除されます。
2232
2233 名前が指定されたテキストのリファレンスでprintfスタイルのフォーマットを実行します。
2234
2235 最初のパラメータは、ハッシュ内での残りのパラメータのフォーマット方法を記述するフォーマット文字列です。詳細については、Rubyの[`Kernel::sprintf`](https://ruby-doc.org/core-2.4.2/Kernel.html#method-i-sprintf)機能のマニュアルを参照してください。
2236
2237 例: 
2238
2239 ```puppet
2240 $output = sprintf_hash('String: %<foo>s / number converted to binary: %<number>b',
2241                        { 'foo' => 'a string', 'number' => 5 })
2242 # $output = 'String: a string / number converted to binary: 101'
2243 ```
2244
2245 *Type*: rvalue
2246
2247 #### `sort`
2248
2249 **非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`sort`](https://puppet.com/docs/puppet/latest/function.html#sort)関数に置き換えられました。
2250
2251 文字列と配列を語彙的に分類します。
2252
2253 *タイプ*: 右辺値
2254
2255 >*注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。
2256
2257 #### `squeeze`
2258
2259 文字列内の連続した繰り返し('aaaa'など)を単一文字に置き換え、新たな文字列を返します。
2260
2261 *タイプ*: 右辺値
2262
2263 #### `str2bool`
2264
2265 特定の文字列をブーリアンに変換します。値'1'、'true'、't'、'y'、'yes'を含む文字列は`true`に変換されます。値'0'、'false'、'f'、'n'、'no'を含む文字列、および空文字列または未定義文字列は`false`に変換されます。その他の値の場合、エラーが生じます。このチェックでは、大文字と小文字は区別されません。
2266
2267 Puppet 5.0.0以降では、タイプシステムを使用して同じことが行えます。
2268 利用可能な多くのタイプ変換については、Puppetの[`Boolean.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-boolean) 
2269 関数を参照してください。
2270
2271     Boolean('false'), Boolean('n'), Boolean('no') # すべてfalse
2272     Boolean('true'), Boolean('y'), Boolean('yes') # すべてtrue
2273
2274 *タイプ*: 右辺値
2275
2276 #### `str2saltedsha512`
2277
2278 OS Xバージョン10.7以上で使用されるソルト付きSHA512パスワードハッシュに文字列を変換します。hexバージョンのソルト付きSHA512パスワードハッシュを返します。これは、有効なパスワード属性としてPuppetマニフェストに挿入することができます。
2279
2280 *タイプ*: 右辺値
2281
2282 >*注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。
2283
2284 #### `strftime`
2285
2286 **非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`strftime`](https://puppet.com/docs/puppet/latest/function.html#`strftime`)関数に置き換えられました。
2287
2288 フォーマットされた時刻を返します。
2289
2290 たとえば、`strftime("%s")`はUnixエポックからの経過時間を返し、`strftime("%Y-%m-%d")`は日付を返します。
2291
2292 引数: `strftime`フォーマットで時間を指定する文字列。詳細については、Ruby [strftime](https://ruby-doc.org/core-2.1.9/Time.html#method-i-strftime)ドキュメントを参照してください。
2293
2294 *タイプ*: 右辺値
2295
2296 >*注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。
2297
2298 *フォーマット:*
2299
2300 *  `%a`: 曜日の名称の短縮形('Sun')
2301 * `%A`: 曜日の完全な名称('Sunday')
2302 * `%b`: 月の名称の短縮形('Jan')
2303 * `%B`: 月の完全な名称('January')
2304 * `%c`: 推奨される地域の日付および時刻の表現
2305 * `%C`: 世紀(2009年であれば20)
2306 * `%d`: その月の日(01..31)
2307 * `%D`: 日付(%m/%d/%y)
2308 * `%e`: その月の日、1桁の場合は半角空白で埋める( 1..31)
2309 * `%F`: %Y-%m-%d(ISO 8601の日付フォーマット)と同等
2310 * `%h`: %bと同等
2311 * `%H`: 24時間制の時(00..23)
2312 * `%I`: 12時間制の時(01..12)
2313 * `%j`: 年中の通算日(001..366)
2314 * `%k`: 24時間制の時、1桁の場合は半角空白で埋める( 0..23)
2315 * `%l`: 12時間制の時、1桁の場合は半角空白で埋める( 0..12)
2316 * `%L`: ミリ秒(000..999)
2317 * `%m`: その年の月(01..12)
2318 * `%M`: 分(00..59)
2319 * `%n`: 改行(\n)
2320 * `%N`: 秒の小数点以下の桁、デフォルトは9桁(ナノ秒)
2321   * `%3N`: ミリ秒(3桁)
2322   * `%6N`: マイクロ秒(6桁)
2323   * `%9N`: ナノ秒(9桁)
2324 * `%p`: 午前または午後('AM'または'PM')
2325 * `%P`: 午前または午後('am'または'pm')
2326 * `%r`: 12時間制の時刻(%I:%M:%S %pと同等)
2327 * `%R`: 24時間制の時刻(%H:%M)
2328 * `%s`: Unixエポック、1970-01-01 00:00:00 UTCからの経過秒
2329 * `%S`: 秒(00..60)
2330 * `%t`: タブ文字(   )
2331 * `%T`: 24時間制の時刻(%H:%M:%S)
2332 * `%u`: 月曜日を1とした、曜日の数値表現(1..7)
2333 * `%U`: 最初の日曜日を第1週の始まりとした、現在の週を表す数(00..53)
2334 * `%v`: VMS形式の日付(%e-%b-%Y)
2335 * `%V`: ISO 8601形式の暦週(01..53)
2336 * `%W`: 最初の月曜日を第1週の始まりとした、現在の週を表す数(00..53)
2337 * `%w`: 曜日(日曜が0、0..6)
2338 * `%x`: 推奨される日付のみの表現、時刻はなし
2339 * `%X`: 推奨される時刻のみの表現、日付はなし
2340 * `%y`: 世紀なしの年(00..99)
2341 * `%Y`: 世紀ありの年
2342 * `%z`: タイムゾーン、UTCからのオフセット(+0900など)
2343 * `%Z`: タイムゾーンの名称
2344 * `%%`: '%'文字
2345
2346 #### `strip`
2347
2348 **非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`strip`](https://puppet.com/docs/puppet/latest/function.html#`strip`)関数に置き換えられました。
2349
2350 1つの文字列、または配列内のすべての文字列から、冒頭および末尾の空白を削除します。たとえば、`strip("    aaa   ")`は"aaa"になります。
2351
2352 *タイプ*: 右辺値
2353
2354 #### `suffix`
2355
2356 配列のすべての要素、またはハッシュのすべてのキーに接尾辞を適用します。
2357
2358 例: 
2359
2360 * `suffix(['a','b','c'], 'p')`は['ap','bp','cp']を返します。
2361 * `suffix({'a'=>'b','b'=>'c','c'=>'d'}, 'p')`は{'ap'=>'b','bp'=>'c','cp'=>'d'}を返します。
2362
2363 Puppet 4.0.0以降では、内蔵の[`map`](https://docs.puppet.com/puppet/latest/function.html#map)関数を使用して配列の値を変更します。この例は、上記の最初の例と同じです。
2364
2365     ['a', 'b', 'c'].map |$x| { "${x}p" }
2366
2367 *タイプ*: 右辺値
2368
2369 #### `swapcase`
2370
2371 文字列の現在の大文字と小文字を入れ替えます。たとえば、`swapcase("aBcD")`は"AbCd"になります。
2372
2373 *タイプ*: 右辺値
2374
2375 >*注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。
2376
2377 #### `time`
2378
2379 現在のUnixエポック時刻を整数として返します。
2380
2381 たとえば、`time()`は'1311972653'などを返します。
2382
2383 Puppet 4.8.0以降、Puppet言語には、``Timestamp` (時点)と`Timespan` (期間)の各データタイプがあります。次の例は、引数なしで`time()`を呼び出すのと同じです。
2384
2385 タイムスタンプ()
2386
2387 *タイプ*: 右辺値
2388
2389 #### `to_bytes`
2390
2391 引数をバイトに変換します。
2392
2393 たとえば、"4 kB"は"4096"になります。
2394
2395 引数: 単一の文字列。
2396
2397 *タイプ*: 右辺値
2398
2399 #### `to_json`
2400
2401 入力値をJSON形式の文字列に変換します。
2402
2403 例えば、`{ "key" => "value" }`は`{"key":"value"}`になります。
2404
2405 *タイプ*: 右辺値
2406
2407 #### `to_json_pretty`
2408
2409 入力値を整形されたJSON形式の文字列に変換します。
2410
2411 例えば、`{ "key" => "value" }`は`{\n  \"key\": \"value\"\n}`になります。
2412
2413 *タイプ*: 右辺値
2414
2415 #### `to_yaml`
2416
2417 入力値をYAML形式の文字列に変換します。
2418
2419 例えば、`{ "key" => "value" }`は`"---\nkey: value\n"`になります。
2420
2421 *タイプ*: 右辺値
2422
2423 #### `try_get_value`
2424
2425 **非推奨:** `dig()`に置き換えられました。
2426
2427 ハッシュおよび配列の複数レイヤー内の値を取得します。
2428
2429 引数:
2430
2431 * 第1の引数として、パスを含む文字列。この引数は、ゼロではじまり、パス区切り文字(デフォルトは"/")で区切ったハッシュキーまたは配列インデックスの文字列として提示してください。この関数は各パスコンポーネントにより構造内を移動し、パスの最後で値を返すよう試みます。
2432
2433 * デフォルトの第2の引数。パスが正しくない場合や、値が見つからない場合、その他のエラーが生じた場合は、この引数が返されます。
2434 * 最後の引数として、パス区切り文字。
2435
2436 ```ruby
2437 $data = {
2438   'a' => {
2439     'b' => [
2440       'b1',
2441       'b2',
2442       'b3',
2443     ]
2444   }
2445 }
2446
2447 $value = try_get_value($data, 'a/b/2')
2448 # $value = 'b3'
2449
2450 # with all possible options
2451 $value = try_get_value($data, 'a/b/2', 'not_found', '/')
2452 # $value = 'b3'
2453
2454 # using the default value
2455 $value = try_get_value($data, 'a/b/c/d', 'not_found')
2456 # $value = 'not_found'
2457
2458 # using custom separator
2459 $value = try_get_value($data, 'a|b', [], '|')
2460 # $value = ['b1','b2','b3']
2461 ```
2462
2463 1. **$data** 取り扱うデータ構造。
2464 2. **'a/b/2'** パス文字列。
2465 3. **'not_found'** デフォルト値。何も見つからない場合に返されます。
2466    (オプション、デフォルトは`undef`)
2467 4. **'/'** パス区切り文字。
2468    (オプション、デフォルトは*'/'*)
2469
2470 *タイプ*: 右辺値
2471
2472 #### `type3x`
2473
2474 **非推奨:**この関数は、今後のリリースで廃止されます。 
2475
2476 与えられた値のタイプを説明する文字列を返します。タイプとしては、文字列、配列、ハッシュ、フロート、整数、ブーリアンが可能です。Puppet 4では、この代わりに新しいタイプシステムを使用してください。
2477
2478 引数:
2479
2480 * 文字列
2481 * 配列
2482 * ハッシュ
2483 * フロート
2484 * 整数
2485 * ブーリアン
2486
2487 *タイプ*: 右辺値
2488
2489 #### `type_of`
2490
2491 この関数は下位互換性を得るために提供されていますが、Puppetで提供されている内蔵の[type()関数](https://puppet.com/docs/puppet/latest/function.html#type)の使用を推奨します。
2492
2493 与えられた値のリテラル型を返します。Puppet 4が必要です。`if type_of($some_value) <= Array[String] { ... }`のように(これは`if $some_value =~ Array[String] { ... }`に相当します)、`<=`を用いたタイプの比較に役立ちます。
2494
2495 *タイプ*: 右辺値
2496
2497 #### `union`
2498
2499 2つ以上の配列を重複なしで結合したものを返します。
2500
2501 たとえば、`union(["a","b","c"],["b","c","d"])`は["a","b","c","d"]を返します。
2502
2503 *タイプ*: 右辺値
2504
2505 #### `unique`
2506
2507 文字列および配列から重複を削除します。
2508
2509 たとえば、`unique("aabbcc")`は'abc'を、`unique(["a","a","b","b","c","c"])`は["a","b","c"]を返します。
2510
2511 *タイプ*: 右辺値
2512
2513 #### `unix2dos`
2514
2515 与えられた文字列のDOSバージョンを返します。クロスプラットフォームテンプレートでファイルリソースを使用する場合に役立ちます。
2516
2517 *タイプ*: 右辺値
2518
2519 ```puppet
2520 file { $config_file:
2521   ensure  => file,
2522   content => unix2dos(template('my_module/settings.conf.erb')),
2523 }
2524 ```
2525
2526 [dos2unix](#dos2unix)も参照してください。
2527
2528 #### `upcase`
2529
2530 **非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`upcase`](https://puppet.com/docs/puppet/latest/function.html#upcase)関数に置き換えられました。
2531
2532 オブジェクト、配列、オブジェクトのハッシュを大文字に変換します。変換されるオブジェクトは、大文字化に対応するものでなければなりません。
2533
2534 たとえば、`upcase('abcd')`は'ABCD'を返します。
2535
2536 *タイプ*: 右辺値
2537
2538 *注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。
2539
2540 #### `uriescape`
2541
2542 文字列または文字列の配列をURLエンコードします。
2543
2544 引数: 単一の文字列または文字列の配列。
2545
2546 *タイプ*: 右辺値
2547
2548 >*注:* この関数はRubyクラスの実装にあたり、UTF8との互換性がない可能性があります。互換性を確保するには、Ruby 2.4.0以降でこの関数を使用してください。
2549
2550 #### `validate_absolute_path`
2551
2552 ファイルシステムの絶対パスを表す任意の文字列の有効性を確認します。WindowsおよびUnix形式のパスで機能します。
2553
2554 以下の値が渡されます:
2555
2556 ```puppet
2557 $my_path = 'C:/Program Files (x86)/Puppet Labs/Puppet'
2558 validate_absolute_path($my_path)
2559 $my_path2 = '/var/lib/puppet'
2560 validate_absolute_path($my_path2)
2561 $my_path3 = ['C:/Program Files (x86)/Puppet Labs/Puppet','C:/Program Files/Puppet Labs/Puppet']
2562 validate_absolute_path($my_path3)
2563 $my_path4 = ['/var/lib/puppet','/usr/share/puppet']
2564 validate_absolute_path($my_path4)
2565 ```
2566
2567 以下の値は失敗になり、コンパイルが中止されます:
2568
2569 ```puppet
2570 validate_absolute_path(true)
2571 validate_absolute_path('../var/lib/puppet')
2572 validate_absolute_path('var/lib/puppet')
2573 validate_absolute_path([ 'var/lib/puppet', '/var/foo' ])
2574 validate_absolute_path([ '/var/lib/puppet', 'var/foo' ])
2575 $undefined = `undef`
2576 validate_absolute_path($undefined)
2577 ```
2578
2579 *タイプ*: ステートメント
2580
2581 #### `validate_array`
2582
2583 **非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。
2584
2585 渡されたすべての値が配列データ構造であることを確認します。このチェックで不合格となった値がある場合は、カタログコンパイルが中止されます。
2586
2587 以下の値が渡されます:
2588
2589 ```puppet
2590 $my_array = [ 'one', 'two' ]
2591 validate_array($my_array)
2592 ```
2593
2594 以下の値は失敗になり、コンパイルが中止されます:
2595
2596 ```puppet
2597 validate_array(true)
2598 validate_array('some_string')
2599 $undefined = `undef`
2600 validate_array($undefined)
2601 ```
2602
2603 *タイプ*: ステートメント
2604
2605 #### `validate_augeas`
2606
2607 Augeasレンズを用いて文字列を確認します。
2608
2609 引数:
2610
2611 * 第1の引数として、テストする文字列。
2612 * 第2の引数として、使用するAugeasレンズの名前。
2613 * オプションの第3の文字列として、ファイル内で見つかるべき**ではない**パスのリスト。
2614 * オプションの第4の引数として、ユーザに表示するエラーメッセージ。
2615
2616 Augeasがレンズによる文字列の構文解析に失敗した場合は、構文エラーによりコンパイルが中止されます。 
2617
2618 `$file`変数は、Augeasツリーでテストされる一時ファイルのロケーションを示します。
2619
2620 たとえば、$passwdcontentにユーザの`foo`が含まれないようにするには、第3の引数を以下のようにします:
2621
2622 ```puppet
2623 validate_augeas($passwdcontent, 'Passwd.lns', ['$file/foo'])
2624 ```
2625
2626 エラーメッセージを生成して表示するには、第4の引数を以下のようにします:
2627
2628 ```puppet
2629 validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers content with Augeas')
2630 ```
2631
2632 *タイプ*: ステートメント
2633
2634 #### `validate_bool`
2635
2636 **非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。
2637
2638 渡されたすべての値が`true`または`false`であることを確認します。このチェックで不合格となった値がある場合は、カタログコンパイルが中止されます。
2639
2640 以下の値が渡されます:
2641
2642 ```puppet
2643 $iamtrue = true
2644 validate_bool(true)
2645 validate_bool(true, true, false, $iamtrue)
2646 ```
2647
2648 以下の値は失敗になり、コンパイルが中止されます:
2649
2650 ```puppet
2651 $some_array = [ true ]
2652 validate_bool("false")
2653 validate_bool("true")
2654 validate_bool($some_array)
2655 ```
2656
2657 *タイプ*: ステートメント
2658
2659 #### `validate_cmd`
2660
2661 外部コマンドにより文字列を確認します。
2662
2663 引数:
2664 * 第1の引数として、テストする文字列。
2665 * 第2の引数として、テストコマンドのパス。この引数は、ファイルパスのプレースホルダ―として%をとります(%プレースホルダーが与えられていない場合、デフォルトはコマンド末尾)。パスした文字列を含む一時ファイルに対してコマンドが起動した場合や、ゼロではない値が返された場合は、構文エラーによりコンパイルが中止されます。
2666 * オプションの第3の引数として、ユーザに表示するエラーメッセージ。
2667
2668 ```puppet
2669 # Defaults to end of path
2670 validate_cmd($sudoerscontent, '/usr/sbin/visudo -c -f', 'Visudo failed to validate sudoers content')
2671 ```
2672
2673 ```puppet
2674 # % as file location
2675 validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to validate config content')
2676 ```
2677
2678 *タイプ*: ステートメント
2679
2680 #### `validate_domain_name`
2681
2682 **非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。
2683
2684 渡されたすべての値が構文的に正しいドメイン名であることを確認します。このチェックで不合格となった値がある場合は、カタログコンパイルが中止されます。
2685
2686 以下の値が渡されます:
2687
2688 ~~~
2689 $my_domain_name = 'server.domain.tld'
2690 validate_domain_name($my_domain_name)
2691 validate_domain_name('domain.tld', 'puppet.com', $my_domain_name)
2692 ~~~
2693
2694 以下の値が不合格となり、コンパイルが中止されます: 
2695
2696 ~~~
2697 validate_domain_name(1)
2698 validate_domain_name(true)
2699 validate_domain_name('invalid domain')
2700 validate_domain_name('-foo.example.com')
2701 validate_domain_name('www.example.2com')
2702 ~~~
2703
2704 *タイプ*: ステートメント
2705
2706 #### `validate_email_address`
2707
2708 渡されたすべての値が有効なメールアドレスであることを確認します。このチェックで不合格となった値がある場合、コンパイルが失敗します。
2709
2710 以下の値が渡されます:
2711
2712 ~~~
2713 $my_email = "waldo@gmail.com"
2714 validate_email_address($my_email)
2715 validate_email_address("bob@gmail.com", "alice@gmail.com", $my_email)
2716 ~~~
2717
2718 以下の値が不合格となり、コンパイルが中止されます: 
2719
2720 ~~~
2721 $some_array = [ 'bad_email@/d/efdf.com' ]
2722 validate_email_address($some_array)
2723 ~~~
2724
2725 *タイプ*: ステートメント
2726
2727 #### `validate_hash`
2728
2729 **非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。
2730
2731 渡されたすべての値がハッシュデータ構造であることを確認します。このチェックで不合格となった値がある場合は、カタログコンパイルが中止されます。
2732
2733 以下の値が渡されます:
2734
2735 ```puppet
2736 $my_hash = { 'one' => 'two' }
2737 validate_hash($my_hash)
2738 ```
2739
2740 以下の値は失敗になり、コンパイルが中止されます:
2741
2742 ```puppet
2743 validate_hash(true)
2744 validate_hash('some_string')
2745 $undefined = `undef`
2746 validate_hash($undefined)
2747 ```
2748
2749 *タイプ*: ステートメント
2750
2751 #### `validate_integer`
2752
2753 **非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。
2754
2755 整数または整数の配列を確認します。いずれかがチェックで不合格になった場合には、カタログコンパイルが中止されます。
2756
2757 引数:
2758
2759 * 第1の引数として、整数または整数の配列。
2760 * オプションの第2の引数として、最大値。第1の引数(のすべての要素)は、この最大値以下でなければなりません。
2761 * オプションの第3の引数として、最小値。第1の引数(のすべての要素)は、この最大値以上でなければなりません。
2762
2763 第1の引数が整数または整数の配列でない場合や、第2または第3の引数が整数に変換できない場合は、この関数は失敗になります。ただし、最小値が与えられている場合は(この場合に限られます)、第2の引数を空文字列または`undef`にすることが可能です。これは、最小チェックを確実に行うためのプレースホルダーとして機能します。
2764
2765 以下の値が渡されます:
2766
2767 ```puppet
2768 validate_integer(1)
2769 validate_integer(1, 2)
2770 validate_integer(1, 1)
2771 validate_integer(1, 2, 0)
2772 validate_integer(2, 2, 2)
2773 validate_integer(2, '', 0)
2774 validate_integer(2, `undef`, 0)
2775 $foo = `undef`
2776 validate_integer(2, $foo, 0)
2777 validate_integer([1,2,3,4,5], 6)
2778 validate_integer([1,2,3,4,5], 6, 0)
2779 ```
2780
2781 * 加えて、上述のすべて。ただし、文字列として渡された値を任意に組み合わせたもの('1'または"1")。
2782 * 加えて、上述のすべて。ただし、負の整数値を(適切に)組み合わせたもの。
2783
2784 以下の値は失敗になり、コンパイルが中止されます:
2785
2786 ```puppet
2787 validate_integer(true)
2788 validate_integer(false)
2789 validate_integer(7.0)
2790 validate_integer({ 1 => 2 })
2791 $foo = `undef`
2792 validate_integer($foo)
2793 validate_integer($foobaridontexist)
2794
2795 validate_integer(1, 0)
2796 validate_integer(1, true)
2797 validate_integer(1, '')
2798 validate_integer(1, `undef`)
2799 validate_integer(1, , 0)
2800 validate_integer(1, 2, 3)
2801 validate_integer(1, 3, 2)
2802 validate_integer(1, 3, true)
2803 ```
2804
2805 * 加えて、上述のすべて。ただし、文字列として渡された値を任意に組み合わせたもの (`false`、または"false")。
2806 * 加えて、上述のすべて。ただし、負の整数値を不適切に組み合わせたもの。
2807 * 加えて、上述のすべて。ただし、配列内の非整数アイテムまたは最大/最小引数を用いたもの。
2808
2809 *タイプ*: ステートメント
2810
2811 #### `validate_ip_address`
2812
2813 **非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。
2814
2815 IPv4アドレスかIPv6アドレスかにかかわらず、引数がIPアドレスであることを確認します。また、ネットマスクによりIPアドレスを確認します。
2816
2817 引数: IPアドレスを指定する文字列。
2818
2819 以下の値が渡されます:
2820
2821 ```puppet
2822 validate_ip_address('0.0.0.0')
2823 validate_ip_address('8.8.8.8')
2824 validate_ip_address('127.0.0.1')
2825 validate_ip_address('194.232.104.150')
2826 validate_ip_address('3ffe:0505:0002::')
2827 validate_ip_address('::1/64')
2828 validate_ip_address('fe80::a00:27ff:fe94:44d6/64')
2829 validate_ip_address('8.8.8.8/32')
2830 ```
2831
2832 以下の値は失敗になり、コンパイルが中止されます:
2833
2834 ```puppet
2835 validate_ip_address(1)
2836 validate_ip_address(true)
2837 validate_ip_address(0.0.0.256)
2838 validate_ip_address('::1', {})
2839 validate_ip_address('0.0.0.0.0')
2840 validate_ip_address('3.3.3')
2841 validate_ip_address('23.43.9.22/64')
2842 validate_ip_address('260.2.32.43')
2843 ```
2844
2845
2846 #### `validate_legacy`
2847
2848 指定したタイプおよび非推奨の確認関数の両方に照らして値を確認します。両方にパスした場合はそのままパスし、片方の確認のみにパスした場合はエラーが生じ、両方の確認でfalseが返された場合は失敗になります。
2849
2850 引数:
2851
2852 * 値のチェックに用いるタイプ。
2853 * 過去の確認関数のフルネーム。
2854 * チェックする値。
2855 * 過去の確認関数に必要な引数の不特定数。
2856
2857 例:
2858
2859 ```puppet
2860 validate_legacy('Optional[String]', 'validate_re', 'Value to be validated', ["."])
2861 ```
2862
2863 この関数は、Puppet 3形式の引数確認(stdlibの`validate_*`関数を使用)からPuppet 4データタイプへのモジュールのアップデートに対応しており、Puppet 3形式の確認に頼っている場合も機能性が中断することはありません。
2864
2865 > 注: この関数は、Puppet 4.4.0 (PE 2016.1)以降にのみ対応しています。
2866
2867 ##### モジュールユーザへ
2868
2869 Puppet 4を使用している場合、`validate_legacy`関数を使えば、非推奨のPuppet 3の`validate_*`関数を探し、分離することができます。これらの関数は、stdlibバージョン4.13時点で非推奨になっており、今後のstdlibバージョンでは削除されます。
2870
2871 Puppet 4では、[データタイプ](https://puppet.com/docs/puppet/latest/lang_data.html)を用いた改良版のユーザ定義タイプのチェックが可能です。データタイプでは、Puppet 3の`validate_*`関数で見られた、不整合につながるいくつかの問題を回避できます。例えば、[validate_numeric](#validate_numeric)では、数字だけでなく、数字の配列や数字のように見える文字列も意図に反して許可されていました。
2872
2873 Puppet 4とともに、非推奨の `validate_*`関数を用いたモジュールを使用している場合は、非推奨メッセージが表示されることがあります。`validate_legacy`関数を使えば、そうした差異を可視化し、より明快なPuppet 4構文に簡単に移行することができます。
2874
2875 表示される非推奨メッセージは、使用しているモジュールやデータによって異なることがあります。以下の非推奨メッセージは、Puppet 4でのみデフォルトで表示されます:
2876
2877 * `Notice: Accepting previously invalid value for target type '<type>'`: このメッセージは、情報提供の目的のみで表示されるものです。使用している値は、新形式で許可されていますが、旧確認関数では無効となります。
2878 * `Warning: This method is deprecated, please use the stdlib validate_legacy function`: モジュールがまだ`validate_legacy`にアップグレードされていません。[deprecation](#deprecation)オプションを使用してさしあたり警告を解除するか、モジュールの開発者に修正版を提出させてください。この問題の解決方法については、以下の[モジュール開発者へ](#モジュール開発者へ)を参照してください。
2879 * `Warning: validate_legacy(<function>) expected <type> value, got <actual type>_`: コードが渡す値は、Puppet 3形式の確認では認められますが、次バージョンのモジュールでは認められません。ほとんどの場合、数字またはブーリアンからクォートを削除すれば、この問題を解決することができます。
2880 * `Error: Evaluation Error: Error while evaluating a Resource Statement, Evaluation Error: Error while evaluating a Function Call, validate_legacy(<function>) expected <type> value, got <actual type>`: コードの渡す値は、新形式の確認でも旧形式の確認でも認められません。
2881
2882 ##### モジュール開発者へ
2883
2884 `validate_legacy`関数は、モジュールユーザの使用している機能を中断させずに、 Puppet 3形式の確認からPuppet 4形式の確認に移行するのに役立ちます。
2885
2886 Puppet 4形式の確認に移行すれば、[データタイプ](https://puppet.com/docs/puppet/latest/lang_data.html)を用いた、より明確なユーザ定義タイプのチェックが可能になります。Puppet 3の`validate_*` 関数の多くは、確認という点で驚くほど多くの穴があります。例えば、[validate_numeric](#validate_numeric)では、細部をコントロールできないため、数字だけでなく、数字の配列や数字のように見える文字列も許可されます。
2887
2888 クラスおよび定義タイプの各パラメータについて、使用する新しいPuppet 4データタイプを選択してください。たいていの場合、新しいデータタイプにより、元の`validate_*`関数とは異なる値のセットを使用できるようになります。以下のような状況になります:
2889
2890 |              | `validate_` pass | `validate_` fail |
2891 | ------------ | ---------------- | ---------------- |
2892 | タイプに一致します | 成功             | 成功、通知     |
2893 | タイプの失敗   | 成功、廃止予定 | 失敗             |
2894
2895 現在のところ、確認後のコードでも、すべての可能な値に対処する必要がありますが、新形式にマッチする値のみを渡すように、コードのユーザがマニフェストを変更することができます。
2896
2897 stdlibの`validate_*`関数それぞれについて、マッチする`Stdlib::Compat::*`タイプがあり、適切な値のセットが許可されます。注意事項については、stdlibソースコードの `types/`ディレクトリにあるドキュメントを参照してください。
2898
2899 たとえば、数字のみが許可されるクラスを与えると、以下のようになります:
2900
2901 ```puppet
2902 class example($value) {
2903   validate_numeric($value)
2904 ```
2905
2906 得られる確認コードは、以下のようになります:
2907
2908 ```puppet
2909 クラスの例(
2910   Variant[Stdlib::Compat::Numeric, Numeric] $value
2911 ) {
2912   validate_legacy(Numeric, 'validate_numeric', $value)
2913 ```
2914
2915 ここでは、`$value`のタイプが`Variant[Stdlib::Compat::Numeric, Numeric]`と定義されています。これにより、任意の`Numeric` (新形式)のほか、`validate_numeric`で(`Stdlib::Compat::Numeric`を通じて)これまで許可されていたすべての値を使用できます。
2916
2917 `validate_legacy`を呼び出すと、適切なログまたは失敗メッセージのトリガーが処理されます。これには、新形式、以前の確認関数の名称、およびその関数のすべての引数が必要です。
2918
2919 お使いのモジュールがまだPuppet 3をサポートしている場合は、これは互換性を破る変更になります。`metadata.json`要件セクションをアップデートしてモジュールがもうPuppet 3をサポートしていないことを示し、モジュールのメジャーバージョンを放棄してください。この変更を加えても、モジュールに関する既存のすべてのテストにパスするはずです。新たに可能になった値について、追加のテストを作成してください。
2920
2921 これは互換性を破る変更であることから、取り除きたいすべてのパラメータについて [`deprecation`](#deprecation)をコールしたり、パラメータにさらなる制約を追加したりする良い機会でもあります。
2922
2923 このバージョンのリリース後、互換性を破る変更を加えた別のリリースを公開し、すべての互換性タイプおよび `validate_legacy`のコールを削除することができます。その時点で、コードを実行し、過去に可能だった値に関する残余要素を取り除くこともできます。
2924
2925 そうした変更については、必ずCHANGELOGおよびREADMEで通告してください。
2926
2927 #### `validate_numeric`
2928
2929 **非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。
2930
2931 数値または数値の配列や文字列を確認します。いずれかがチェックに失敗した場合には、カタログコンパイルが中止されます。
2932
2933 引数:
2934
2935 * 数値、または数値の配列か文字列。
2936 * オプションで、最大値。第1の引数(のすべての要素) は、この最大値以下でなければなりません。
2937 * オプションで、最小値。第1の引数(のすべての要素)は、この最小値以上でなければなりません。
2938
2939 第1の引数が数値(整数またはフロート)または数値の配列が文字列でない場合や、第2および第3の引数が数値に変換できない場合は、この関数は失敗になります。最小値が与えられている場合は(この場合に限られます)、第2の引数を空文字列または`undef`にすることが可能です。これは、最小チェックを確実に行うためのプレースホルダーとして機能します。
2940
2941 パスおよび失敗の使用については、[`validate_integer`](#validate-integer)を参照してください。同じ値がパスおよび失敗します。ただし、`validate_numeric`では、浮動小数点値も許可されます。
2942
2943 *タイプ*: ステートメント
2944
2945 #### `validate_re`
2946
2947 **非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。
2948
2949 1つまたは複数の正規表現に照らして、文字列の簡単な確認を行います。
2950
2951 引数:
2952
2953 * 第1の引数として、テストする文字列。この引数が文字列でない場合、コンパイルが中止されます。クォートを用いて強制的に文字列化してください。
2954 * 第2の引数として、文字列化した正規表現(区切り文字//なし)または正規表現の配列。
2955 * オプションの第3の引数として、ユーザに表示するエラーメッセージ。
2956
2957 第2の引数の正規表現が第1の引数で渡した文字列にマッチしない場合は、構文エラーによりコンパイルが中止されます。
2958
2959 以下の文字列により、正規表現に照らして確認が行われます:
2960
2961 ```puppet
2962 validate_re('one', '^one$')
2963 validate_re('one', [ '^one', '^two' ])
2964 ```
2965
2966 以下の文字列では、確認に失敗し、コンパイルが中止されます:
2967
2968 ```puppet
2969 validate_re('one', [ '^two', '^three' ])
2970 ```
2971
2972 エラーメッセージの設定方法:
2973
2974 ```puppet
2975 validate_re($::puppetversion, '^2.7', 'The $puppetversion fact value does not match 2.7')
2976 ```
2977
2978 強制的に文字列化するには、クォートを使用してください:
2979
2980   ```
2981   validate_re("${::operatingsystemmajrelease}", '^[57]$')
2982   ```
2983
2984 *タイプ*: ステートメント
2985
2986 #### `validate_slength`
2987
2988 **非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。
2989
2990 文字列(または文字列の配列)が指定した長さ以下であることを確認します。
2991
2992 引数:
2993
2994 * 第1の引数として、文字列または文字列の配列。
2995 * 第2の引数として、長さの最大値を示す数値。
2996 * オプションの第3の引数として、長さの最小値を示す数値。
2997
2998   以下の値が渡されます:
2999
3000 ```puppet
3001 validate_slength("discombobulate",17)
3002 validate_slength(["discombobulate","moo"],17)
3003 validate_slength(["discombobulate","moo"],17,3)
3004 ```
3005
3006 以下の値は失敗になります:
3007
3008 ```puppet
3009 validate_slength("discombobulate",1)
3010 validate_slength(["discombobulate","thermometer"],5)
3011 validate_slength(["discombobulate","moo"],17,10)
3012 ```
3013
3014 *タイプ*: ステートメント
3015
3016 #### `validate_string`
3017
3018 **非推奨:**今後のバージョンのstdlibでは削除されます。[`validate_legacy`](#validate_legacy)を参照してください。
3019
3020 渡したすべての値が文字列データ構造であることを確認します。このチェックに失敗した値がある場合は、カタログコンパイルが中止されます。
3021
3022 以下の値が渡されます:
3023
3024 ```puppet
3025 $my_string = "one two"
3026 validate_string($my_string, 'three')
3027 ```
3028
3029 以下の値は失敗になり、コンパイルが中止されます:
3030
3031 ```puppet
3032 validate_string(true)
3033 validate_string([ 'some', 'array' ])
3034 ```
3035
3036 注:* validate_string(`undef`)は、このバージョンの関数APIでは失敗しません。
3037
3038 代わりに、以下を使用してください:
3039
3040   ```
3041   if $var == `undef` {
3042     fail('...')
3043   }
3044   ```
3045
3046 *タイプ*: ステートメント
3047
3048 #### `validate_x509_rsa_key_pair`
3049
3050 OpenSSLにより、PEMフォーマットされたX.509認証および秘密鍵を確認します。認証の署名が提供された鍵から作成されたものであることを確認します。
3051
3052 このチェックに失敗した値がある場合は、カタログコンパイルが中止されます。
3053
3054 引数:
3055
3056 * 第1の引数として、X.509認証。
3057 * 第2の引数として、RSAプライベートキー。
3058
3059 ```puppet
3060 validate_x509_rsa_key_pair($cert, $key)
3061 ```
3062
3063 *タイプ*: ステートメント
3064
3065 #### `values`
3066
3067 **非推奨:**この関数は、Puppet 5.5.0で、内蔵の[`values`](https://puppet.com/docs/puppet/latest/function.html#values)関数に置き換えられました。
3068
3069 与えられたハッシュの値を返します。
3070
3071 たとえば、`$hash = {'a'=1, 'b'=2, 'c'=3} values($hash)`を与えると、[1,2,3]を返します。
3072
3073 *タイプ*: 右辺値
3074
3075 #### `values_at`
3076
3077 ロケーションをもとに、配列内の値を探します。
3078
3079 引数:
3080
3081 * 第1の引数として、解析したい配列。
3082 * 第2の引数として、以下の値の任意の組み合わせ:
3083   * 単一の数値インデックス。
3084   * 'start-stop'の形式での範囲(4-9など)。
3085   * 上記を組み合わせた配列。
3086
3087 例: 
3088
3089 * `values_at(['a','b','c'], 2)`は['c']を返します。
3090 * `values_at(['a','b','c'], ["0-1"])`は['a','b']を返します。
3091 * `values_at(['a','b','c','d','e'], [0, "2-3"])`は['a','c','d']を返します。
3092
3093 Puppet 4.0.0以降では、インデックスで配列をスライスし、言語で直接カウントすることができます。
3094 負の値は、配列の"最後から"と解釈されます。例えば、次のようになります。
3095
3096 ```puppet
3097 ['a', 'b', 'c', 'd'][1, 2]   # results in ['b', 'c']
3098 ['a', 'b', 'c', 'd'][2, -1]  # results in ['c', 'd']
3099 ['a', 'b', 'c', 'd'][1, -2]  # results in ['b', 'c']
3100 ```
3101
3102 *タイプ*: 右辺値
3103
3104 #### `zip`
3105
3106 与えられた第1の配列から1つの要素をとり、与えられた第2の配列の対応する要素と結合します。これにより、n-要素配列のシーケンスが生成されます。*n*は、引数の数より1大きくなります。たとえば、`zip(['1','2','3'],['4','5','6'])`は["1", "4"], ["2", "5"], ["3", "6"]を返します。*タイプ*: 右辺値。
3107
3108 ## 制約事項
3109
3110 Puppet Enterprise 3.7では、stdlibモジュールがPEに含まれていません。PEユーザは、Puppetと互換性のあるstdlibの最新リリースをインストールする必要があります。
3111
3112 サポートされているオペレーティングシステムの一覧については、[metadata.json](https://github.com/puppetlabs/puppetlabs-stdlib/blob/master/metadata.json)を参照してください。
3113
3114 ### バージョン互換性
3115
3116 バージョン | Puppet 2.6 | Puppet 2.7 | Puppet 3.x | Puppet 4.x |
3117 :---------------|:-----:|:---:|:---:|:----:
3118 **stdlib 2.x**  | **yes** | **yes** | いいえ | いいえ
3119 **stdlib 3.x**  | いいえ    | **yes**  | **yes** | いいえ
3120 **stdlib 4.x**  | いいえ    | **yes**  | **yes** | いいえ
3121 **stdlib 4.6+**  | いいえ    | **yes**  | **yes** | **yes**
3122 **stdlib 5.x**  | いいえ    | いいえ  | **yes**  | **yes**
3123
3124 **stdlib 5.x**:  stdlib 5.xのリリース時には、Puppet 2.7.xのサポートが廃止されます。[この説明](https://github.com/puppetlabs/puppetlabs-stdlib/pull/176#issuecomment-30251414)を参照してください。
3125
3126 ## 開発
3127
3128 Puppet ForgeのPuppet Labsモジュールはオープンプロジェクトで、良い状態に保つためには、コミュニティの貢献が必要不可欠です。Puppetが役に立つはずでありながら、私たちがアクセスできないプラットフォームやハードウェア、ソフトウェア、デプロイ構成は無数にあります。私たちの目標は、できる限り簡単に変更に貢献し、みなさまの環境で私たちのモジュールが機能できるようにすることにあります。最高の状態を維持できるようにするために、コントリビュータが従う必要のあるいくつかのガイドラインが存在します。詳細については、[モジュールコントリビューションガイド](https://docs.puppetlabs.com/forge/contributing.html)を参照してください。
3129
3130 このモジュールの一部に関するバグの報告または調査は、
3131 [http://tickets.puppetlabs.com/browse/MODULES](http://tickets.puppetlabs.com/browse/MODULES)からお願いします。
3132
3133 ## コントリビュータ
3134
3135 コントリビュータのリストは、[https://github.com/puppetlabs/puppetlabs-stdlib/graphs/contributors](https://github.com/puppetlabs/puppetlabs-stdlib/graphs/contributors)で見ることができます。