コマンド・オプション

--name <NAME> | --n <NAME>

インスタンスの名前。

--alert-name <ALERT_NAME>

アラートの名前。

--description <DESCRIPTION>

アラートの情報。

--type <TYPE>

アラートのタイプ。 有効な値は、MANUAL、BASELINE、および HOST_COMPARISON です。

--timespan <TIMESPAN>

アラートをトリガーする前にアラート条件を満たす必要がある最小の時間間隔をマイクロ秒単位で指定します。 デフォルト値は 60,000,000 マイクロ秒です。

--condition <CONDITION>

アラートのしきい値。 このパラメーターは、手動アラートの場合のみ必須で、その他のアラート・タイプには適用されません。

--severity <SEVERITY> | -s <SEVERITY>

重大度のレベル。 有効な値の範囲は 0 から 7 です。0 は緊急を意味し、7 はデバッグを意味します。 デフォルトでは、重大度は 4 に設定されています。

--severity-label <LOW | MEDIUM | HIGH>

アラートの重要度。 有効な値は、HIGH、MEDIUM、LOW です。重大度の値が低いほど、重大度が高いことを示します。

--disable

アラートの状態。 デフォルトでは、アラートは、その作成時に有効になります。 アラートの作成時にアラートを無効にする場合は、このパラメーターを設定しなければなりません。

--segment <SEGMENT>

追加のセグメンテーション条件。 例えば、['host.mac', 'proc.name'] でアラートをセグメント化できます。

--segment-condition <SEGMENT_CONDITION>

--segment パラメーターで指定される各モニター対象エンティティーに対してアラートがトリガーされる条件を定義します。 このパラメーターは、手動アラートの場合のみ必須で、その他のアラート・タイプには適用されません。 有効な値は ANY および ALL です。ANY は、少なくとも 1 つのモニター対象エンティティーが条件を満たす場合にアラートがトリガーされることを示します。ALL は、すべてのモニター対象エンティティーが条件を満たす場合にアラートがトリガーされることを示します。

--user-filter <USER_FILTER>

アラートの範囲を縮小するために設定できるブール式。 kubernetes.namespace.name='production' や container.image='nginx' のようなフィルターなど、セグメントを構成するにはこのパラメーターを使用します。

--notify <NOTIFY>

このアラートで生成する通知のタイプ。 オプションは EMAIL、SNS、PAGER_DUTY、および SYSDIG_DUMP です。

--file <FILE> | -f <JSON_FILE>

新しいアラートの作成のために設定されたデータが含まれている JSON ファイルの名前。 このコマンドを呼び出す前に、alert.json ファイルを作成するようにしてください。

--region <REGION> | -r <REGION>

リージョンの名前 (us-south や eu-gb など)。 指定しない場合は、ログインしているリージョンまたはターゲットになっているリージョンが使用されます。

--output <FORMAT>

二重引用符 (") で囲まれた出力設定のコンマ区切りリスト。指定する設定が 1 つのみの場合、二重引用符は省略できます。 サポートされているオプションは、WIDE と JSON です。

JSON を指定すると、出力が JSON 形式で返されます。 JSON を指定しない場合は、出力が表形式で返されます。

WIDE の場合は、出力として追加の詳細情報が返されます。

--team <TEAM_NAME>

許可のために使用される IBM Cloud Monitoring チームの名前。 チームが指定されない場合は、デフォルト・チームが使用されます。

--help | -h

コマンドで使用できるオプションがリストされます。

例

ibmcloud monitoring alert add コマンドの使用例を以下に示します。

IBM Cloud Monitoring abc インスタンスに関するアラートを追加し、過去 5 分間の CrashLoopBackOff を検出します。

ibmcloud monitoring alert add \
        --name "IBM Cloud Monitoring abc" \
        --description "Alert to report crashLoopBackOffs that are detected" \
        --severity 2 \
        --timespan 300 \
        --condition 'sum(avg(kubernetes.pod.restart.count)) > 1' \
        --alert-name '[Kubernetes] Pod crash/restart loop'

IBM Cloud Monitoring abc インスタンスに関するアラートを追加し、過去 5 分間の重大度が medium に設定された CrashLoopBackOff を検出します。

ibmcloud monitoring alert add \
        --name "IBM Cloud Monitoring abc" \
        --description "Alert to report crashLoopBackOffs that are detected" \
        --severity 2 \
        --severity-label MEDIUM \
        --timespan 300 \
        --condition 'sum(avg(kubernetes.pod.restart.count)) > 1' \
        --alert-name '[Kubernetes] Pod crash/restart loop'

コマンド・オプション

--name <NAME> | --n <NAME>

インスタンスの名前。

--region <REGION> | -r <REGION>

リージョンの名前 (us-south や eu-gb など)。 指定しない場合は、ログインしているリージョンまたはターゲットになっているリージョンが使用されます。

--severity <SEVERITY> | -s <SEVERITY>

二重引用符 (") で囲まれた重大度値のコンマ区切りリスト。指定する重大度が 1 つのみの場合、二重引用符は省略できます。

--output <FORMAT>

二重引用符 (") で囲まれた出力設定のコンマ区切りリスト。指定する設定が 1 つのみの場合、二重引用符は省略できます。 サポートされているオプションは、WIDE と JSON です。

JSON を指定すると、出力が JSON 形式で返されます。 JSON を指定しない場合は、出力が表形式で返されます。

WIDE の場合は、出力として追加の詳細情報が返されます。

--enabled <TRUE | FALSE> | -e <TRUE | FALSE>

アラート通知設定に基づいて、どのアラートをリストするかを指定するブール値。 --enabled true を指定すると、通知 (E メールや Slack など) が有効になっているインスタンスのアラートが表示されます。 --enabled false を指定すると、通知が有効になっていないインスタンスのアラートのリストが返されます。

--team <TEAM_NAME>

許可のために使用される IBM Cloud Monitoring チームの名前。 チームが指定されない場合は、デフォルト・チームが使用されます。

--help | -h

コマンドで使用できるオプションがリストされます。

例

ibmcloud monitoring alert list コマンドの使用例を以下に示します。

IBM Cloud Monitoring abc インスタンスのすべてのアラートを表示します。

ibmcloud monitoring alert list --name "IBM Cloud Monitoring abc"

IBM Cloud Monitoring abc リージョンにある us-south インスタンスのすべてのアラートを表示します。

ibmcloud monitoring alert list --name "IBM Cloud Monitoring abc" --region us-south

IBM Cloud Monitoring abc インスタンスに関して、重大度が low と medium で、通知が有効になっていないすべてのアラートを表示します。

ibmcloud monitoring alert list --name "IBM Cloud Monitoring abc" --enabled false --severity low,medium

コマンド・オプション

--name <NAME> | --n <NAME>

インスタンスの名前。

--id <ALERT_ID>

アラートの ID。

--region <REGIO> | -r <REGION>

リージョンの名前 (us-south や eu-gb など)。 指定しない場合は、ログインしているリージョンまたはターゲットになっているリージョンが使用されます。

--output <FORMAT>

二重引用符 (") で囲まれた出力設定のコンマ区切りリスト。指定する設定が 1 つのみの場合、二重引用符は省略できます。 サポートされているオプションは、WIDE と JSON です。

JSON を指定すると、出力が JSON 形式で返されます。 JSON を指定しない場合は、出力が表形式で返されます。

WIDE の場合は、出力として追加の詳細情報が返されます。

--team <TEAM_NAME>

許可のために使用される IBM Cloud Monitoring チームの名前。 チームが指定されない場合は、デフォルト・チームが使用されます。

--help | -h

コマンドで使用できるオプションがリストされます。

例

ibmcloud monitoring alert get コマンドの使用例を以下に示します。

IBM Cloud Monitoring abc インスタンスに関する ID が 1234567 のアラートの詳細を取得します。

ibmcloud monitoring alert get --name "IBM Cloud Monitoring abc" --id 1234567

IBM Cloud Monitoring abc リージョンで us-south インスタンスに関する ID が 1234567 のアラートの詳細を取得します。

ibmcloud monitoring alert get --name "IBM Cloud Monitoring abc" --id 1234567 --region us-south

コマンド・オプション

--name <NAME> | --n <NAME>

インスタンスの名前。

--id <ALERT_ID>

アラートの ID。

--file <FILE> | -f <JSON_FILE>

アラート定義のあるデータが含まれている JSON ファイルの名前。 このコマンドを呼び出す前に、alert.json ファイルを作成するか変更するようにしてください。

--region <REGION> | -r <REGION>

リージョンの名前 (us-south や eu-gb など)。 指定しない場合は、ログインしているリージョンまたはターゲットになっているリージョンが使用されます。

--output <TYPE>

二重引用符 (") で囲まれた出力設定のコンマ区切りリスト。指定する設定が 1 つのみの場合、二重引用符は省略できます。 サポートされているオプションは、WIDE と JSON です。

JSON を指定すると、出力が JSON 形式で返されます。 JSON を指定しない場合は、出力が表形式で返されます。

WIDE の場合は、出力として追加の詳細情報が返されます。

--team <TEAM_NAME>

許可のために使用される IBM Cloud Monitoring チームの名前。 チームが指定されない場合は、デフォルト・チームが使用されます。

--help | -h

コマンドで使用できるオプションがリストされます。

例

ibmcloud monitoring alert update コマンドの使用例を以下に示します。

IBM Cloud Monitoring abc インスタンスに関する ID が 1234567 のアラートを更新します。

ibmcloud monitoring alert update --name "IBM Cloud Monitoring abc" --id 1234567 --file alert.json

IBM Cloud Monitoring abc リージョンで us-south インスタンスに関する ID が 1234567 のアラートを更新します。

ibmcloud monitoring alert update --name "IBM Cloud Monitoring abc" --id 1234567 --file alert.json --region us-south

コマンド・オプション

--name <NAME> | --n <NAME>

インスタンスの名前。

--id <ALERT_ID>

アラートの ID。

--region <REGION> | -r <REGION>

リージョンの名前 (us-south や eu-gb など)。 指定しない場合は、ログインしているリージョンまたはターゲットになっているリージョンが使用されます。

--force

プロンプトを抑制し、--name で指定されたインスタンスからアラートを削除します。

--team <TEAM_NAME>

許可のために使用される IBM Cloud Monitoring チームの名前。 チームが指定されない場合は、デフォルト・チームが使用されます。

--help | -h

コマンドで使用できるオプションがリストされます。

例

ibmcloud monitoring alert delete コマンドの使用例を以下に示します。

IBM Cloud Monitoring abc インスタンスに関する ID が 1234567 のアラートを削除します。

ibmcloud monitoring alert delete --name "IBM Cloud Monitoring abc" --id 1234567 --file alert.json

IBM Cloud Monitoring abc リージョンで us-south インスタンスに関する ID が 1234567 のアラートを削除します。

ibmcloud monitoring alert delete --name "IBM Cloud Monitoring abc" --id 1234567 --file alert.json --region us-south

コマンド・オプション

--region <REGION> | -r <REGION>

リージョンの名前 (us-south や eu-gb など)。 指定しない場合は、ログインしているリージョンまたはターゲットになっているリージョンが使用されます。

--all-regions

すべてのリージョンでホストされているサービス。

-g <RESOURCE_GROUP>

ホスト・サービスに関連付けられたリソース・グループ。

--all-resource-groups

すべてのリソース・グループでホストされているサービス。

--quiet | -q

詳細出力を抑制します。

--output <FORMAT>

二重引用符 (") で囲まれた出力設定のコンマ区切りリスト。指定する設定が 1 つのみの場合、二重引用符は省略できます。 サポートされているオプションは、WIDE と JSON です。

JSON を指定すると、出力が JSON 形式で返されます。 JSON を指定しない場合は、出力が表形式で返されます。

WIDE の場合は、出力として追加の詳細情報が返されます。

--help | -h

コマンドで使用できるオプションがリストされます。

例

ibmcloud monitoring service-instances コマンドの使用例を以下に示します。

すべてのモニタリング・サービス・インスタンスを表示します。

ibmcloud monitoring service-instances

test-rg リソース・グループにあるすべてのインスタンスを表示します。

ibmcloud monitoring service-instances -g test-rg

すべてのインスタンスを表示し、追加の詳細情報 (ID、GUID、リソース ID など) を含めます。

ibmcloud monitoring service-instances --output wide

すべてのインスタンスを表示し、最小限の詳細情報 (名前、リージョン、状態) のみを含めます。

ibmcloud monitoring service-instances --quiet

us-south リージョンのすべてのインスタンスを表示します。

ibmcloud monitoring service-instances --region us-south

us-south リージョンのすべてのインスタンスを表示し、出力を JSON 形式で返します。

ibmcloud monitoring service-instances --region us-south --output json

コマンド・オプション

--name <NAME> | --n <NAME>

インスタンスの名前。

--region <REGION> | -r <REGION>

リージョンの名前 (us-south や eu-gb など)。 指定しない場合は、ログインしているリージョンまたはターゲットになっているリージョンが使用されます。

--force

プロンプトを抑制し、既存のプラットフォーム・メトリック・インスタンスを、--name で指定したインスタンスに置き換えます。

--help | -h

コマンドで使用できるオプションがリストされます。

例

ibmcloud monitoring platform-metrics-receiver コマンドの使用例を以下に示します。

IBM Cloud Monitoring abc を、プラットフォーム・メトリックを受け取るインスタンスとして構成します。

ibmcloud monitoring platform-metrics-receiver --name "IBM Cloud Monitoring abc"

IBM Cloud Monitoring abc リージョンにある eu-gb を、プラットフォーム・メトリックを受け取るインスタンスとして構成します。

ibmcloud monitoring platform-metrics-receiver --name "IBM Cloud Monitoring abc" --region eu-gb

コマンド・オプション

--name <NAME> | --sn <NAME>

インスタンスの名前。

--region <REGION> | -r <REGION>

リージョンの名前 (us-south や eu-gb など)。 指定しない場合は、ログインしているリージョンまたはターゲットになっているリージョンが使用されます。

--output <TYPE>

二重引用符 (") で囲まれた出力設定のコンマ区切りリスト。指定する設定が 1 つのみの場合、二重引用符は省略できます。 サポートされているオプションは、WIDE と JSON です。

JSON を指定すると、出力が JSON 形式で返されます。 JSON を指定しない場合は、出力が表形式で返されます。

WIDE の場合は、出力として追加の詳細情報が返されます。

--team <TEAM_NAME>

許可のために使用される IBM Cloud Monitoring チームの名前。 チームが指定されない場合は、デフォルト・チームが使用されます。

--help | -h

コマンドで使用できるオプションがリストされます。

例

ibmcloud monitoring dashboard list コマンドの使用例を以下に示します。

IBM Cloud Monitoring abc インスタンスのすべてのダッシュボードを表示します。

ibmcloud monitoring dashboard list

IBM Cloud Monitoring abc リージョンにある us-south インスタンスのすべてのダッシュボードを表示します。

ibmcloud monitoring dashboard list --region us-south

コマンド・オプション

--name <NAME> | --sn <NAME>

インスタンスの名前。

--id <DASHBOARD_ID>

特定のサービス・インスタンスの Dashboard_ID。

--region <REGION> | -r <REGION>

リージョンの名前 (us-south や eu-gb など)。 指定しない場合は、ログインしているリージョンまたはターゲットになっているリージョンが使用されます。

--team <TEAM_NAME>

許可のために使用される IBM Cloud Monitoring チームの名前。 チームが指定されない場合は、デフォルト・チームが使用されます。

--help | -h

コマンドで使用できるオプションがリストされます。

例

ibmcloud monitoring dashboard get コマンドの使用例を以下に示します。

IBM Cloud Monitoring abc インスタンスに関する ID が 1234567 のダッシュボードの情報を取得します。

ibmcloud monitoring dashboard get --name "IBM Cloud Monitoring abc"

IBM Cloud Monitoring abc リージョンで us-south インスタンスに関する ID が 1234567 のダッシュボードの情報を取得します。

ibmcloud monitoring dashboard get --name "IBM Cloud Monitoring abc" --region us-south

コマンド・オプション

--file <FILE> | -f <JSON_FILE>

新しいダッシュボードの作成に関する情報が含まれている JSON ファイルの名前。 このコマンドを呼び出す前に、dashboard.json ファイルを作成するようにしてください。

--name <NAME> | --sn <NAME>

インスタンスの名前。

--region <REGION> | -r <REGION>

リージョンの名前 (us-south や eu-gb など)。 指定しない場合は、ログインしているリージョンまたはターゲットになっているリージョンが使用されます。

--team <TEAM_NAME>

許可のために使用される IBM Cloud Monitoring チームの名前。 チームが指定されない場合は、デフォルト・チームが使用されます。

--help | -h

コマンドで使用できるオプションがリストされます。

例

ibmcloud monitoring dashboard add-json コマンドの使用例を以下に示します。

IBM Cloud Monitoring abc インスタンスに関するダッシュボードを作成します。

ibmcloud monitoring dashboard add-json --name "IBM Cloud Monitoring abc" --file dashboard.json

IBM Cloud Monitoring abc リージョンにある us-south インスタンスのダッシュボードを作成します。

ibmcloud monitoring dashboard add-json --name "IBM Cloud Monitoring abc" --file dashboard.json --region us-south

コマンド・オプション

--name <NAME> | --sn <NAME>

インスタンスの名前。

--region <REGION> | -r <REGION>

リージョンの名前 (us-south や eu-gb など)。 指定しない場合は、ログインしているリージョンまたはターゲットになっているリージョンが使用されます。

--last <DURATION>

イベントをリスト表示する期間。 例えば、12h を設定して過去 12 時間のイベントを表示したり、15m を設定して過去 15 分間のイベントを表示したり、10d を設定して過去 10 日間のイベントを表示したりできます。

--from <TIMESTAMP>

イベントの開始時間を示す、UNIX タイム・スタンプ (秒)。

--to <TIMESTAMP>

イベントの終了に関する秒単位の UNIX タイム・スタンプ。

--limit <LIMIT>

要求で指定された期間に出力されるイベントの最大数。 デフォルトでは、このパラメーターは 100 個のイベントに設定されます。 設定できるイベントの最大数は 10000 です。

--output <TYPE>

二重引用符 (") で囲まれた出力設定のコンマ区切りリスト。指定する設定が 1 つのみの場合、二重引用符は省略できます。 サポートされているオプションは、WIDE と JSON です。

JSON を指定すると、出力が JSON 形式で返されます。 JSON を指定しない場合は、出力が表形式で返されます。

WIDE の場合は、出力として追加の詳細情報が返されます。

--team <TEAM_NAME>

許可のために使用される IBM Cloud Monitoring チームの名前。 チームが指定されない場合は、デフォルト・チームが使用されます。

--help | -h

コマンドで使用できるオプションがリストされます。

例

ibmcloud monitoring event list コマンドの使用例を以下に示します。

IBM Cloud Monitoring abc インスタンスのイベントをリストします。

ibmcloud monitoring event list --name "IBM Cloud Monitoring abc"

IBM Cloud Monitoring abc リージョンにある us-south インスタンスのイベントを表示します。

ibmcloud monitoring event list --name "IBM Cloud Monitoring abc" --region us-south

過去 1 時間の、IBM Cloud Monitoring abc リージョンにある us-south インスタンスのイベントを表示します。

ibmcloud monitoring event list --name "IBM Cloud Monitoring abc" --region us-south --duration 1H

コマンド・オプション

--name <NAME> | --sn <NAME>

インスタンスの名前。

--region <REGION> | -r <REGION>

リージョンの名前 (us-south や eu-gb など)。 指定しない場合は、ログインしているリージョンまたはターゲットになっているリージョンが使用されます。

--output <TYPE>

二重引用符 (") で囲まれた出力設定のコンマ区切りリスト。指定する設定が 1 つのみの場合、二重引用符は省略できます。 サポートされているオプションは、WIDE と JSON です。

JSON を指定すると、出力が JSON 形式で返されます。 JSON を指定しない場合は、出力が表形式で返されます。

WIDE の場合は、出力として追加の詳細情報が返されます。

--help | -h

コマンドで使用できるオプションがリストされます。

例

ibmcloud monitoring settings notification list コマンドの使用例を以下に示します。

IBM Cloud Monitoring abc インスタンスの通知チャネルを表示します。

ibmcloud monitoring settings notification list --name "IBM Cloud Monitoring abc"

IBM Cloud Monitoring abc リージョンにある us-south インスタンスの通知チャネルを表示します。

ibmcloud monitoring settings notification list --name "IBM Cloud Monitoring abc" --region us-south

コマンド・オプション

--name <NAME> | --sn <NAME>

インスタンスの名前。

--region <REGION> | -r <REGION>

リージョンの名前 (us-south や eu-gb など)。 指定しない場合は、ログインしているリージョンまたはターゲットになっているリージョンが使用されます。

--output <TYPE>

二重引用符 (") で囲まれた出力設定のコンマ区切りリスト。指定する設定が 1 つのみの場合、二重引用符は省略できます。 サポートされているオプションは、WIDE と JSON です。

JSON を指定すると、出力が JSON 形式で返されます。 JSON を指定しない場合は、出力が表形式で返されます。

WIDE の場合は、出力として追加の詳細情報が返されます。

--help | -h

コマンドで使用できるオプションがリストされます。

例

ibmcloud monitoring settings team list コマンドの使用例を以下に示します。

IBM Cloud Monitoring abc インスタンスのチームを表示します。

ibmcloud monitoring settings team list --name "IBM Cloud Monitoring abc"

IBM Cloud Monitoring abc リージョンにある us-south インスタンスのチームを表示します。

ibmcloud monitoring settings team list --name "IBM Cloud Monitoring abc" --region us-south

コマンド・オプション

--name <NAME> | --sn <NAME>

インスタンスの名前。

--region <REGION> | -r <REGION>

リージョンの名前 (us-south や eu-gb など)。 指定しない場合は、ログインしているリージョンまたはターゲットになっているリージョンが使用されます。

--teamID <TEAM_ID>

チームの ID。

--output <TYPE>

二重引用符 (") で囲まれた出力設定のコンマ区切りリスト。指定する設定が 1 つのみの場合、二重引用符は省略できます。 サポートされているオプションは、WIDE と JSON です。

JSON を指定すると、出力が JSON 形式で返されます。 JSON を指定しない場合は、出力が表形式で返されます。

WIDE の場合は、出力として追加の詳細情報が返されます。

--help | -h

コマンドで使用できるオプションがリストされます。

例

ibmcloud monitoring settings user list コマンドの使用例を以下に示します。

IBM Cloud Monitoring abc インスタンスのユーザーを表示します。

ibmcloud monitoring settings user list --name "IBM Cloud Monitoring abc"

IBM Cloud Monitoring abc リージョンにある us-south インスタンスのユーザーを表示します。

ibmcloud monitoring settings user list --name "IBM Cloud Monitoring abc" --region us-south