1. index
  2. 監視
  3. 設定
  4. コマンド
  5. その他

externalcommand オブジェクト

externalcommandオブジェクトは、X-MONの外部コマンド情報を操作するオブジェクトです。

externalcommand.get外部コマンドの取得

externalcommand.getは、外部コマンドの情報を取得するためのメソッドです。

対応X-MONバージョン
  • 3.0.9 以降
必要ユーザ権限
  • システム管理者
  • 運用責任者
  • オペレータ
  • 閲覧者
  • 通知ユーザ

閲覧者権限のユーザは、閲覧対象ホストグループが設定されている場合、閲覧対象として許可されている外部コマンド情報のみが取得されます。

リクエストパラメータ

カラム名称 型 概要
type string

取得する外部コマンドの種別を指定します。

all
全ての外部コマンド履歴を取得します。
host
ホストの外部コマンド履歴を取得します。
service
サービスの外部コマンド履歴を取得します。

省略時には、allが指定されます。

レスポンスカラム

カラム名称 型 概要
host_name string

ホストID
service_display_name string

サービスID
author string

コマンド実行ユーザID
comment string

コマンド実行時に指定したコメント
id string

外部コマンドID
persistent string

保持設定

0
保持せずに再起動時に消去
1
保持する
entry_type string

コマンドの種類

1
ユーザコマンド
2
ダウンタイムスケジュール
3
フラップ検知
4
認知済み
entry_time string

コマンド発行日時のUNIXTIME
expires string

有効期限の設定

0
有効期限を設定しない
1
有効期限を設定する
expire_time string

有効期限のUNIXTIME