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

commandDowntime オブジェクト

commandDowntimeオブジェクトは、ダウンタイムスケジュールの操作を行うオブジェクトです。

cmd_del_host_downtime.set指定ホストのダウンタイムスケジュールを削除

cmd_del_host_downtime.setは、指定したホストに対して登録されているダウンタイムスケジュールを削除します。

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

リクエストパラメータ

カラム名称 型 概要
host_name 必須 string ダウンタイムスケジュールを削除するホストIDを指定します。
downtime_id 必須 integer 削除するダウンタイムスケジュールIDを指定します。

レスポンスカラム

このメソッドは、実行結果が boolean型で返ってきます。

cmd_del_svc_downtime.set指定サービスのダウンタイムスケジュールを削除

cmd_del_all_svc_downtimes.setは、指定したサービスに対して登録されているダウンタイムスケジュールを削除します。

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

リクエストパラメータ

カラム名称 型 概要
host_name 必須 string ダウンタイムスケジュールを削除するホストIDを指定します。
service_description 必須 string ダウンタイムスケジュールを削除するサービスIDを指定します。
downtime_id 必須 integer 削除するダウンタイムスケジュールIDを指定します。

レスポンスカラム

このメソッドは、実行結果が boolean型で返ってきます。

cmd_schedule_and_propagate_host_downtime.setホストのダウンタイムと、ダウンタイムをトリガとしていない全ての子ホストをスケジュール

cmd_schedule_and_propagate_host_downtime.setは、指定したホストとダウンタイムをトリガとしていない全ての子ホストに対してダウンタイムスケジュールを設定します。

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

リクエストパラメータ

カラム名称 型 概要
host_name 必須 string ダウンタイムスケジュールを設定するホストIDを指定します。
start_time string

ダウンタイムの開始日時を指定します。

省略時には、コマンドを発行した日時が指定されます。
end_time string

ダウンタイムの終了日時を指定します。

省略時には、ダウンタイムの開始日時から2時間後が指定されます。
fixed boolean

ダウンタイムの種類を指定します。

true

固定スケジュールのダウンタイムになります。

固定スケジュールの場合、指定した開始日時から終了日時までの期間をダウンタイムとみなします。

false

フレキシブルスケジュールのダウンタイムになります。

フレキシブルスケジュールの場合、指定した開始日時から終了日時までの期間に、障害が発生してからdurationで指定した分数の間をダウンタイムとみなします。

省略時には、trueが指定されます。
duration integer

フレキシブルスケジュールの期間を分数で指定します。

省略時には、120が指定されており、2時間と解釈されます。
trigger_id integer

トリガーとなるdowntime_idを指定します。
comment string

コメントを指定します。

省略時には、ダウンタイムを誰が設定したかの情報が記述されます。

レスポンスカラム

このメソッドは、実行結果が boolean型で返ってきます。

cmd_schedule_and_propagate_triggered_host_downtime.setホストのダウンタイムと、ダウンタイムをトリガとする全ての子ホストをスケジュール

cmd_schedule_and_propagate_triggered_host_downtime.setは、指定したホストとダウンタイムをトリガとする全ての子ホストに対してダウンタイムスケジュールを設定します。

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

リクエストパラメータ

カラム名称 型 概要
host_name 必須 string ダウンタイムスケジュールを設定するホストIDを指定します。
start_time string

ダウンタイムの開始日時を指定します。

省略時には、コマンドを発行した日時が指定されます。
end_time string

ダウンタイムの終了日時を指定します。

省略時には、ダウンタイムの開始日時から2時間後が指定されます。
fixed boolean

ダウンタイムの種類を指定します。

true

固定スケジュールのダウンタイムになります。

固定スケジュールの場合、指定した開始日時から終了日時までの期間をダウンタイムとみなします。

false

フレキシブルスケジュールのダウンタイムになります。

フレキシブルスケジュールの場合、指定した開始日時から終了日時までの期間に、障害が発生してからdurationで指定した分数の間をダウンタイムとみなします。

省略時には、trueが指定されます。
duration integer

フレキシブルスケジュールの期間を分数で指定します。

省略時には、120が指定されており、2時間と解釈されます。
trigger_id integer

トリガーとなるdowntime_idを指定します。
comment string

コメントを指定します。

省略時には、ダウンタイムを誰が設定したかの情報が記述されます。

レスポンスカラム

このメソッドは、実行結果が boolean型で返ってきます。

cmd_schedule_host_downtime.set指定したホストのダウンタイムをスケジュール

cmd_schedule_host_downtime.setは、指定したホストのダウンタイムスケジュールを設定します。

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

リクエストパラメータ

カラム名称 型 概要
host_name 必須 string ダウンタイムスケジュールを設定するホストIDを指定します。
start_time string

ダウンタイムの開始日時を指定します。

省略時には、コマンドを発行した日時が指定されます。
end_time string

ダウンタイムの終了日時を指定します。

省略時には、ダウンタイムの開始日時から2時間後が指定されます。
fixed boolean

ダウンタイムの種類を指定します。

true

固定スケジュールのダウンタイムになります。

固定スケジュールの場合、指定した開始日時から終了日時までの期間をダウンタイムとみなします。

false

フレキシブルスケジュールのダウンタイムになります。

フレキシブルスケジュールの場合、指定した開始日時から終了日時までの期間に、障害が発生してからdurationで指定した分数の間をダウンタイムとみなします。

省略時には、trueが指定されます。
duration integer

フレキシブルスケジュールの期間を分数で指定します。

省略時には、120が指定されており、2時間と解釈されます。
trigger_id integer

トリガーとなるdowntime_idを指定します。
comment string

コメントを指定します。

省略時には、ダウンタイムを誰が設定したかの情報が記述されます。

レスポンスカラム

このメソッドは、実行結果が boolean型で返ってきます。

cmd_schedule_hostgroup_host_downtime.set指定したホストグループのホストダウンタイムをスケジュール

cmd_schedule_hostgroup_host_downtime.setは、指定したホストグループに所属しているホストのダウンタイムスケジュールを設定します。

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

リクエストパラメータ

カラム名称 型 概要
hostgroup_name 必須 string ダウンタイムスケジュールを設定するホストグループIDを指定します。
start_time string

ダウンタイムの開始日時を指定します。

省略時には、コマンドを発行した日時が指定されます。
end_time string

ダウンタイムの終了日時を指定します。

省略時には、ダウンタイムの開始日時から2時間後が指定されます。
fixed boolean

ダウンタイムの種類を指定します。

true

固定スケジュールのダウンタイムになります。

固定スケジュールの場合、指定した開始日時から終了日時までの期間をダウンタイムとみなします。

false

フレキシブルスケジュールのダウンタイムになります。

フレキシブルスケジュールの場合、指定した開始日時から終了日時までの期間に、障害が発生してからdurationで指定した分数の間をダウンタイムとみなします。

省略時には、trueが指定されます。
duration integer

フレキシブルスケジュールの期間を分数で指定します。

省略時には、120が指定されており、2時間と解釈されます。
comment string

コメントを指定します。

省略時には、ダウンタイムを誰が設定したかの情報が記述されます。

レスポンスカラム

このメソッドは、実行結果が boolean型で返ってきます。

cmd_schedule_hostgroup_svc_downtime.set指定したホストグループのサービスダウンタイムをスケジュール

cmd_schedule_hostgroup_svc_downtime.setは、指定したホストグループに所属しているホストのサービスダウンタイムスケジュールを設定します。

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

リクエストパラメータ

カラム名称 型 概要
hostgroup_name 必須 string ダウンタイムスケジュールを設定するホストグループIDを指定します。
start_time string

ダウンタイムの開始日時を指定します。

省略時には、コマンドを発行した日時が指定されます。
end_time string

ダウンタイムの終了日時を指定します。

省略時には、ダウンタイムの開始日時から2時間後が指定されます。
fixed boolean

ダウンタイムの種類を指定します。

true

固定スケジュールのダウンタイムになります。

固定スケジュールの場合、指定した開始日時から終了日時までの期間をダウンタイムとみなします。

false

フレキシブルスケジュールのダウンタイムになります。

フレキシブルスケジュールの場合、指定した開始日時から終了日時までの期間に、障害が発生してからdurationで指定した分数の間をダウンタイムとみなします。

省略時には、trueが指定されます。
duration integer

フレキシブルスケジュールの期間を分数で指定します。

省略時には、120が指定されており、2時間と解釈されます。
comment string

コメントを指定します。

省略時には、ダウンタイムを誰が設定したかの情報が記述されます。
with_host boolean

ホストダウンタイムも合わせて設定するかどうかを指定します。

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

レスポンスカラム

このメソッドは、実行結果が boolean型で返ってきます。

cmd_schedule_host_svc_downtime.set指定したホストの全てのサービスダウンタイムをスケジュール

cmd_schedule_host_svc_downtime.setは、指定したホストの全てのサービスダウンタイムスケジュールを設定します。

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

リクエストパラメータ

カラム名称 型 概要
host_name 必須 string ダウンタイムスケジュールを設定するホストIDを指定します。
start_time string

ダウンタイムの開始日時を指定します。

省略時には、コマンドを発行した日時が指定されます。
end_time string

ダウンタイムの終了日時を指定します。

省略時には、ダウンタイムの開始日時から2時間後が指定されます。
fixed boolean

ダウンタイムの種類を指定します。

true

固定スケジュールのダウンタイムになります。

固定スケジュールの場合、指定した開始日時から終了日時までの期間をダウンタイムとみなします。

false

フレキシブルスケジュールのダウンタイムになります。

フレキシブルスケジュールの場合、指定した開始日時から終了日時までの期間に、障害が発生してからdurationで指定した分数の間をダウンタイムとみなします。

省略時には、trueが指定されます。
duration integer

フレキシブルスケジュールの期間を分数で指定します。

省略時には、120が指定されており、2時間と解釈されます。
trigger_id integer

トリガーとなるdowntime_idを指定します。
comment string

コメントを指定します。

省略時には、ダウンタイムを誰が設定したかの情報が記述されます。

レスポンスカラム

このメソッドは、実行結果が boolean型で返ってきます。

cmd_schedule_servicegroup_host_downtime.set指定したサービスグループのホストダウンタイムをスケジュール

cmd_schedule_servicegroup_host_downtime.setは、指定したサービスグループに所属しているホストのダウンタイムスケジュールを設定します。

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

リクエストパラメータ

カラム名称 型 概要
servicegroup_name 必須 string ダウンタイムスケジュールを設定するサービスグループIDを指定します。
start_time string

ダウンタイムの開始日時を指定します。

省略時には、コマンドを発行した日時が指定されます。
end_time string

ダウンタイムの終了日時を指定します。

省略時には、ダウンタイムの開始日時から2時間後が指定されます。
fixed boolean

ダウンタイムの種類を指定します。

true

固定スケジュールのダウンタイムになります。

固定スケジュールの場合、指定した開始日時から終了日時までの期間をダウンタイムとみなします。

false

フレキシブルスケジュールのダウンタイムになります。

フレキシブルスケジュールの場合、指定した開始日時から終了日時までの期間に、障害が発生してからdurationで指定した分数の間をダウンタイムとみなします。

省略時には、trueが指定されます。
duration integer

フレキシブルスケジュールの期間を分数で指定します。

省略時には、120が指定されており、2時間と解釈されます。
comment string

コメントを指定します。

省略時には、ダウンタイムを誰が設定したかの情報が記述されます。

レスポンスカラム

このメソッドは、実行結果が boolean型で返ってきます。

cmd_schedule_servicegroup_svc_downtime.set指定したサービスグループのサービスダウンタイムをスケジュール

cmd_schedule_servicegroup_svc_downtime.setは、指定したサービスグループに所属しているホストのサービスダウンタイムスケジュールを設定します。

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

リクエストパラメータ

カラム名称 型 概要
servicegroup_name 必須 string ダウンタイムスケジュールを設定するサービスグループIDを指定します。
start_time string

ダウンタイムの開始日時を指定します。

省略時には、コマンドを発行した日時が指定されます。
end_time string

ダウンタイムの終了日時を指定します。

省略時には、ダウンタイムの開始日時から2時間後が指定されます。
fixed boolean

ダウンタイムの種類を指定します。

true

固定スケジュールのダウンタイムになります。

固定スケジュールの場合、指定した開始日時から終了日時までの期間をダウンタイムとみなします。

false

フレキシブルスケジュールのダウンタイムになります。

フレキシブルスケジュールの場合、指定した開始日時から終了日時までの期間に、障害が発生してからdurationで指定した分数の間をダウンタイムとみなします。

省略時には、trueが指定されます。
duration integer

フレキシブルスケジュールの期間を分数で指定します。

省略時には、120が指定されており、2時間と解釈されます。
comment string

コメントを指定します。

省略時には、ダウンタイムを誰が設定したかの情報が記述されます。
with_host boolean

ホストダウンタイムも合わせて設定するかどうかを指定します。

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

レスポンスカラム

このメソッドは、実行結果が boolean型で返ってきます。

cmd_schedule_svc_downtime.set指定したサービスのダウンタイムをスケジュール

cmd_schedule_svc_downtime.setは、指定したサービスのダウンタイムスケジュールを設定します。

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

リクエストパラメータ

カラム名称 型 概要
host_name 必須 string ダウンタイムスケジュールを設定するホストIDを指定します。
service_description 必須 string ダウンタイムスケジュールを削除するサービスIDを指定します。
start_time string

ダウンタイムの開始日時を指定します。

省略時には、コマンドを発行した日時が指定されます。
end_time string

ダウンタイムの終了日時を指定します。

省略時には、ダウンタイムの開始日時から2時間後が指定されます。
fixed boolean

ダウンタイムの種類を指定します。

true

固定スケジュールのダウンタイムになります。

固定スケジュールの場合、指定した開始日時から終了日時までの期間をダウンタイムとみなします。

false

フレキシブルスケジュールのダウンタイムになります。

フレキシブルスケジュールの場合、指定した開始日時から終了日時までの期間に、障害が発生してからdurationで指定した分数の間をダウンタイムとみなします。

省略時には、trueが指定されます。
duration integer

フレキシブルスケジュールの期間を分数で指定します。

省略時には、120が指定されており、2時間と解釈されます。
trigger_id integer

トリガーとなるdowntime_idを指定します。
comment string

コメントを指定します。

省略時には、ダウンタイムを誰が設定したかの情報が記述されます。

レスポンスカラム

このメソッドは、実行結果が boolean型で返ってきます。