4.13.40 日時取得
機能
実行対象サーバ上の現在日時を，指定したフォーマットに従って取得します。
取得後の日時は，取得結果(common.getResultプロパティ)に格納します。
オプションとして，出力する日時のタイムゾーンを指定することができます。
フォーマット(common.dateAndTimeFormatプロパティ)について次に示します。
・64文字以内の文字列を指定してください。
・フォーマット(common.dateAndTimeFormatプロパティ)に指定された文字列内の変換指定文字は，対応する値に変換されます。
ただし，変換指定文字以外の文字列は，変換されずそのまま取得結果(common.getResultプロパティ)に格納します。
変換指定文字の例を次に示します。
[変換指定文字]
%Y 世紀部分を含めた4桁の西暦年。
%y 西暦の下2桁。世紀部分を含まない年。1桁の場合には前に0を設定する。
%m 月。1桁の場合には前に0を設定する。
%d 日。1桁の場合には前に0を設定する。
%H 24時間表記での時。1桁の場合には前に0を設定する。
%I 12時間表記での時。1桁の場合には前に0を設定する。
%M 分。1桁の場合には前に0を設定する。
%S 秒。1桁の場合には前に0を設定する。
%s 1970-01-01 00:00:00 UTC からの秒数
タイムゾーン(OS.timeZoneプロパティ)について次に示します。
・省略した場合，実行対象サーバに対してエージェントレス接続したユーザーに設定されているタイムゾーンで，現在日時を取得します。
・実行対象サーバがWindowsの場合，TZUTILコマンドの/lオプションで確認できる，タイムゾーンIDを指定してください。
指定例を次に示します。
Tokyo Standard Time
China Standard Time
GMT Standard Time
Pacific Standard Time
Eastern Standard Time
US Eastern Standard Time
Central Standard Time
Central America Standard Time
US Mountain Standard Time
Mountain Standard Time
Alaskan Standard Time
Hawaiian Standard Time
Singapore Standard Time
India Standard Time
・実行対象サーバがLinuxの場合，/usr/share/zoneinfoディレクトリ以下にある，タイムゾーンファイル名を指定してください。
指定例を次に示します。
America/Adak
America/Boise
America/Chicago
America/Denver
America/Detroit
America/Juneau
America/Kentucky/Monticello
America/Los_Angeles
America/Louisville
America/Monterrey
America/Montevideo
America/New_York
America/North_Dakota/Center
America/Shiprock
America/Tijuana
America/Vancouver
Asia/Chongqing
Asia/Hong_Kong
Asia/Kolkata
Asia/Macau
Asia/Shanghai
Asia/Singapore
Asia/Tokyo
Etc/UTC
Europe/London
Pacific/Honolulu
取得結果(common.getResultプロパティ)について次に示します。
・実行対象サーバ上の現在日時を，フォーマット(common.dateAndTimeFormatプロパティ)に従って取得します。
・実行対象サーバがWindowsの場合，PowerShellのGet-Dateコマンドレット(-UFormatオプション)の結果を格納します。
・実行対象サーバがUNIXの場合，dateコマンドの結果を格納します。
利用場面
現在日時を特定のフォーマットに変換して使用する場合に使用できます。
前提条件
【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。
また、OSおよび製品について略称を用いています。対象とするOSおよび製品については「はじめに」を参照してください。
【実行対象サーバ内前提製品】
なし。
【実行対象サーバの稼働OS】
(1) Windows Server
(2) Red Hat Enterprise Linux Server
(3) Oracle Linux
【実行対象サーバの使用条件】
(1)実行対象サーバがWindowsの場合に，タイムゾーン(OS.timeZoneプロパティ)を指定する場合は，Microsoft .Net Framework 3.5以降がインストールされていること。
注意事項
(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。
(2)機能説明に記載している変換指定文字以外の変換指定文字も使用できます。実行対象サーバがWindowsの場合は，PowerShellのGet-Dateコマンドレット(-UFormatオプション)のマニュアルを確認してください。UNIXの場合は，dateコマンドのマニュアルを確認してください。ただし，「%n」や「%t」などの制御文字に変換される変換指定文字は指定しないでください。
(3)実行対象サーバがWindowsの場合は，フォーマット(common.dateAndTimeFormatプロパティ)に「{」，「}」を使用しないでください。指定した場合，この部品が異常終了します。
(4)実行対象サーバがUNIXの場合は，タイムゾーン(OS.timeZoneプロパティ)にOS上で定義されていないタイムゾーンを指定した場合，タイムゾーンはUTCとなります。指定したタイムゾーンが，Linuxの場合は/usr/share/zoneinfoディレクトリ以下にあることを確認しください。
(5)取得結果(common.getResultプロパティ)に「%」を出力する場合は，フォーマット(common.dateAndTimeFormatプロパティ)に「%%」と指定してください。
(6)取得結果(common.getResultプロパティ)に格納される値は，この部品の実行開始時間ではありません。実行対象サーバがWindowsの場合は，PowerShellのGet-Dateコマンドレットを実行した時間，UNIXの場合は，dateコマンドを実行した時間が格納されます。
バージョン
04.00.00
部品のタグ
Gather OS information,Windows,Linux
タスクログに表示される部品の名称
osGetDateAndTime
戻り値
|
戻り値 |
説明 |
|---|---|
|
0 |
正常 |
|
12 |
異常(ユーザーミス) プロパティ不正 |
|
27 |
異常(エラー内容はタスクログで確認) |
|
41 |
異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知) |
プロパティ一覧
プロパティ一覧を次の表に示します。
|
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
|---|---|---|---|---|---|
|
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
|
common.dateAndTimeFormat |
フォーマット |
現在日時を変換するフォーマットを指定します。 |
%Y-%m-%dT%H:%M |
入力 |
○ |
|
OS.timeZone |
タイムゾーン |
タイムゾーンを指定します。 |
− |
入力 |
△ |
|
common.getResult |
取得結果 |
現在日時をフォーマットにしたがって取得した結果が格納されます。 |
− |
出力 |
△ |
|
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
△ |