編集状況

この例では、 PATCH /situations エンドポイントを使用してシチュエーションを編集する方法を説明します。

このエンドポイントを使用する場合は、更新する各状況について以下の情報を指定するリクエスト・ボディを提供する必要があります：
  • 定義された状況の名前（ NAME プロパティ）。
  • 状況が最後に変更された日付（ LSTDATE プロパティ）。 この情報をタイムスタンプ値として指定する。 この値は状況が編集されるたびに更新されるため、 PATCH /situations のリクエストごとに値を更新する必要があります。
    注： このタイムスタンプ値は、複数のリクエストが同時に状況を更新するのを防ぐためのロックメカニズムとして使用される。 タイムスタンプのフォーマットについては、 リクエストに時間値を使うを参照のこと。
    ヒント： この値は、 GET /situations エンドポイントを使用して取得できます。 lstdate パラメーターは、レスポンスの一部として返されます。
  • 修正する状況情報。 更新可能なプロパティは、 状況編集リクエスト本文に記述されている。

リクエストのフォーマットは、以下のセクションで説明するように、リクエストの中で単一の状況を編集するか、複数の状況を編集するかによって若干異なります。

リクエストごとに1つの状況を編集する

PATCH /situations エンドポイントを使用して単一の状況を編集する場合、リクエスト・ボディに NAME プロパティ、 LSTDATE プロパティ、および変更する状況情報を含めます。

パスの書式は以下の通り：
https://host:port/api/v1/situations

更新可能なプロパティは、 状況編集リクエスト本文に記述されている。

リクエスト内の複数の状況を編集する

PATCH /situations エンドポイントを使用して、1 つのリクエストで複数のシチュエーションを編集する場合は、更新する各シチュエーションのリクエスト・ボディで NAME および LSTDATE プロパティを使用する必要があります。

パスの書式は以下の通り：
https://host:port/api/v1/situations
リクエストボディに、各状況ごとに個別のオブジェクトとして指定された、各状況ごとに修正する情報を含める。 例:
[
  {
     "NAME" : "sit1", 
     "REEV_DAYS": "1", 
     "LSTDATE" : "01293012930293"
  }, 
  { 
     "NAME" : "sit2", 
     "REEV_DAYS": "1", 
     "LSTDATE" : "01293012930293" 
  }
]

更新可能なプロパティは、 状況編集リクエスト本文に記述されている。

状況編集の依頼主

以下の例は、状況編集リクエストのためのリクエストボディのフォーマットを示し、サポートされるすべてのプロパティを含む：
{
  "NAME": "string",
  "LSTDATE": "string",
  "ADVISE": "string",
  "AUTOSTART": "string",
  "CMD": "string",
  "FULLNAME": "string",
  "PDT": "string"
  "REEV_DAYS": "string",
  "REEV_TIME": "string",
  "SITINFO": {
    "TFWD": "string",
    "SEV": "string",
    "TDST": "string",
    "ATOM": "string",
    "COUNT": "string"
  },
  "TEXT": "string",
  "REFLEXACTION_OPTIONS": {
    "EACH_ROW" : "string",
    "EACH_INTERVAL" : "string",
    "WHERE" : "string"
  },
  "DISTRIBUTION": [
    "string"
  ]
}

リクエストボディには、必ず NAME と LSTDATE プロパティを含めること。 残りのプロパティについては、それぞれの状況に応じて更新したいプロパティのみを含める。

以下の表は、サポートされるプロパティについて説明し、 Tivoli Enterprise Portal (TEP)の関連する場所を示しています。

表 1. 状況編集のためのボディ・プロパティを要求する
プロパティー 説明 TEPにおける位置 状況 エディター
NAME 定義された状況の名前。

NAME 、31文字以内で、数字で始まらず、英数字またはアンダースコアのみを含む値。

注： このパラメータは必須である。
 数式タブ、 名前フィールド
LSTDATE 状況が最後に変更されたタイムスタンプ。

この値は状況が編集されるたびに更新されるため、 PATCH /situations のリクエストごとに値を更新する必要があります。

注： このパラメータは必須である。
  
FULLNAME 値が NAME の基準を満たさない場合の、定義された状況の名称値。

定義された状況の名前は、それが31文字より長い場合、数字で始まる場合、英数字やアンダースコア文字以外の記号（例えば、空白文字、疑問符、感嘆符）を含む場合、 FULLNAME 属性として保存されます。

 数式タブ、 名前フィールド
TEXT シチュエーションの説明。

有効な値：文字列、最大長64バイト

 数式タブ 、説明フィールド
PDT 状況に応じてテストされるしきい値を含む数式。

有効な値：文字列、最大長1022文字

PDT サポートされている状況タイプの例：

  • 標準的な状況：
    "PDT": "*IF *VALUE ALL_THREADS.Plan *EQ K06PLAN *AND *VALUE ALL_THREADS.Plan *EQ K07PLAN"
  • 相関関係がある：
    PDT": "*IF *VALUE *HSITNAME *EQ
SituationToMonitor *AND *VALUE *HNODE *EQ
PLEXA:SYSTEM1:MVSSYS *AND *VALUE
*HDELTASTAT *EQ Y *AND *VALUE
*HSITNAME *EQ SituationToMonitor2 *AND *VALUE
*HNODE *EQ PLEXA:SYSTEM2:MVSSYS *AND
*VALUE *HDELTASTAT *EQ Y"
    注： PDT が有効であるためには、少なくとも2つの既存の状況が含まれていなければならない。 *HDELTASTAT *EQ Y 、その状況が「真実」であることを意味する。 したがって、 Y が唯一有効な *HDELTASTAT の値である。
  • 埋め込まれた状況：
    "PDT": "*IF *SIT SituationToMonitor
*EQ *TRUE *AND *VALUE TableA.ColumnE *GT 90.0"
    注: 有効であるためには、 PDT 、少なくとも1つの既存の状況と、少なくとも1つの他の節（他の既存の状況または属性の比較）を含んでいなければならない。 複数のシチュエーションを含める場合は、同じエージェントまたは All Managed Systems のシチュエーションであることを確認してください。
 数式タブ、 数式フィールド
SITINFO 編集可能な状況定義。

SITINFO オブジェクトには、以下のようなJSONオブジェクト形式のさまざまなプロパティが含まれています

  "SITINFO": {
    "TFWD": "string",
    "SEV": "string",
    "TDST": "string",
    "ATOM": "string",
    "COUNT": "string"
  }
これらのプロパティを更新する際には、状況に応じて定義されたすべての SITINFO プロパティを含める必要があります。 SITINFO の定義は、 GET /situations エンドポイントを使用して取得できます。 例えば、次のような定義がある状況を考えてみましょう
"SITINFO": {
    "SEV": "Harmless",
    "TDST": "0",
    "COUNT": "1"
    }
COUNT プロパティの値を1から2に変更するには、定義済みのプロパティをすべて含める必要があります。以下のように：
"SITINFO": {
    "SEV": "Harmless",
    "TDST": "0",
    "COUNT": "2"
    }

SITINFO の各プロパティの説明については、 表2 を参照してください。

 数式と EIF タブ
REEV_DAYS

REEV_TIME

 サンプリング間隔。 999日間に1回というように、めったに変更しないことも、30秒間隔というように頻繁に変更することも可能です。
有効値:
  • REEV_DAYS の場合、 ddd 形式で0～999日を指定する。
  • REEV_TIME の場合、 hhmmss 形式で、最小値は30秒（000030）、最大値は23時間59分59秒（235959）を指定できる。
例えば、以下の定義では、サンプリング間隔は24時間5分となります
"REEV_DAYS": "1",
"REEV_TIME": "000500"
 数式タブ 、サンプリング間隔フィールド
AUTOSTART 起動時に実行する。

有効な値： *YES 、 *NO

状況が保存されたらすぐにモニタリングを開始したい場合は、 *YES を指定してください。 シチュエーションが配布されたモニター・エージェントがオフラインになった場合、そのエージェントが再度開始すると、シチュエーションは自動的に開始されます。

手動で状況を開始したい場合は、 *NO を指定してください。

 数式タブ、 起動時に実行オプション
DISTRIBUTION 状況に応じて管理されたシステムを実行する。
以下の形式を使用します。
"DISTRIBUTION": ["node_1","node_2"]
node_n は、JSON 配列形式でリスト化された 1 つ以上のノード（管理システム）であり、状況を実行する場所です。
例:
"DISTRIBUTION": [
    "*MVS_DB2",
    "DB2plex:DB2plex:Plexview",
    "TDB2:SYS1:DB2"
    ]
DISTRIBUTION の値を更新する際には、その状況に対して現在定義されているすべてのノード値をリクエストに含める必要があります。 定義済みの値は、 GET /situations エンドポイントを使用して取得できます。 エントリを省略すると、そのノードは配信対象から除外されます。 また、配布にノードを追加することもできます。
重要:
  • すべての状況タイプにおいて、リクエストに空の配列を含めると、すべての定義が削除されます。
  • *HUB相関のある状況では、 DISTRIBUTION の値だけが有効である。
    "DISTRIBUTION": [
            "*HUB"
        ]
  • 埋め込みシチュエーションでは、埋め込みシチュエーションと埋め込みシチュ エーションの両方が、少なくとも1つのマッチする DISTRIBUTION 値を持たなければならない。そうでなければリクエストは無効である。
 配布タブ、 割り当てフィールド
ADVISE 専門家のアドバイス。 ユーザーへの指示を説明するテキストを入力したり、表示するURL を指定したりすることができます。 エキスパートアドバイスタブ、 テキストまたはアドバイス場所フィールド
CMD 状況が真になったときに実行するアクション。
システムコマンドを実行するには、以下の形式を使用します
"CMD": "system_command"
system_command はシステムで発行するコマンドです。
普遍的なメッセージを発行するには、以下のフォーマットを使用します
"CMD": "message:category;severity;universal_msg"
ここで、それぞれ以下のとおりです。
  • message リテラル値です
  • カテゴリーは、最大16文字の単語1つです
  • 厳格さは最大8文字までの単語です
  • universal_msgは、その状況が発生した際に表示されるテキスト（最大245文字）です。
 アクションタブで：
  • システムコマンドの場合： アクション選択の システムコマンドオプション、およびシステムコマンドフィールド。
  • ユニバーサルメッセージ： アクション選択の ユニバーサルメッセージオプション、およびカテゴリ、 重要度、 メッセージフィールド。
REFLEXACTION_OPTIONS そのような状況になったときにとるべき反射的な行動の選択肢を示す。

REFLEXACTION_OPTIONS オブジェクトは、JSONオブジェクト形式で以下のプロパティを含む：

"REFLEXACTION_OPTIONS": {
    "EACH_ROW" : "Y|N",
    "EACH_INTERVAL" : "Y|N",
    "WHERE" : "TEMS|TEMA"
    }
EACH_ROW
複数の監視項目に対して条件が真である場合、 Y を指定して各項目に対してアクションを起こすか、 N を指定して最初の項目に対してのみアクションを起こす。 デフォルト値はNです。
EACH_INTERVAL
条件が複数のインターバルにわたって真であり続ける場合、各インターバルでアクションを起こすには Y 、2回続けてアクションを起こさないには N 。 デフォルト値はNです。
どこで
アクションの実行時に、管理システム（TEMS）でアクションを実行する場合は TEMS を指定し、管理システム（エージェント）でアクションを実行する場合は TEMA を指定します。 デフォルト値はTEMAです。

REFLEXACTION_OPTIONS プロパティを更新する際、プロパティとその値が指定されていない場合、デフォルト値が使用されます。

 アクションタブのオプション：
条件が複数のモニター対象項目に対して true の場合:
  • 最初の項目のみでアクションを実行
  • 各項目に対してアクションを実行
アクションはどこで実行されるべきか：
  • 管理対象システム (エージェント) でアクションを実行する
  • 管理システム (TEMS) でアクションを実行する
複数のインターバルに渡って条件が true の場合:
  • 続けて 2 回アクションを実行しないでください (シチュエーションが false になり、次にもう一度 true になるまで待ってください)
  • 各インターバルでアクションを実行する
次の表は、 SITINFO オブジェクトで定義されている状況情報プロパティについて説明しています
表 2. SITINFOプロパティ
プロパティー 説明 TEPにおける位置 状況 エディター
TFWD イベント統合機能（EIF）転送は、状況イベントを1つ以上のEIF受信者に転送します。

Y を指定すると、状況イベントが1つ以上の EIF 受信者に転送されます。 各状況イベントに対してEIFイベントが送信されます。

有効な値：Y、N

 EIF タブ、 EIF レシーバにイベントを転送するオプション
SEV 転送された状況イベントの深刻度。 EIFタブ 、EIF重大度フィールド
TDST 転送イベントのイベント統合機能（EIF）の宛先。 それぞれの宛先は、1 つ以上の EIF 受信側を表しています。
以下の形式を使用します。
"TDST": ["destination_1","destination_2"]
destination_n は、転送されたイベントが送信される1つ以上の宛先であり、JSON配列形式で記載されています。
 EIF タブ、 割り当て済み EIF レシーバー フィールド
ATOM 複数行の属性グループの場合、データサンプリングおよびオープンイベントで、すべての行をテストし続けることができるように設定できます。

主式で指定され、ATOMIZEの対象となるテーブルの列のみが処理されます。

例えば、以下の定義では、 REALTHDA テーブルの ATOMIZE 処理が可能な列のみが処理されることを示しています
"ATOM": "REALTHDA.TDIDPLAN"
ヒント： GET /system/tables?name=REALTHDA エンドポイントを使用して、 "ATOMIZE": true で示されているように、ATOMIZEの対象となる列を特定することができます。
 数式タブで、 詳細設定を選択します。 詳細状況オプションウィンドウの 「表示項目」 タブ 、「項目」 フィールド。
COUNT 連続した真のサンプル、つまり、イベントが開かれる前に状況が真のまま維持される回数。
以下の形式を使用します。
"COUNT": "number"
ここで 、number は整数です。
 数式タブで、 詳細設定を選択します。 高度な状況オプションウィンドウの状況持続タブの連続真サンプルフィールド。