node-ip-blacklist
データノードで制御ノードと同期されたアドレスグループ(IPブロックリスト)データを照会します。guidまたはnameオプションを指定すると該当アドレスグループのIP項目を照会し、両方とも省略するとすべてのアドレスグループの一覧を照会します。
コマンドプロパティ
| 項目 | 説明 |
|---|---|
| コマンドタイプ | ドライバークエリ |
| 必要な権限 | 管理者 |
| ライセンス使用量 | なし |
| 並列実行 | 非対応 |
| 分散実行 | 非対応 |
構文
アドレスグループの一覧を照会するには
特定のアドレスグループのIP項目をGUIDで照会するには
特定のアドレスグループのIP項目を名前で照会するには(4.0.2609.0以降)
オプション
guid=STR- 照会するアドレスグループのGUID(
nameと同時に使用できません)。省略するとすべてのアドレスグループの一覧を照会します。 name=STR- 照会するアドレスグループの名前(
guidと同時に使用できません)。省略するとすべてのアドレスグループの一覧を照会します。このオプションは4.0.2609.0以降で使用できます。
出力フィールド
guidとnameオプションを両方とも省略した場合(アドレスグループ一覧):
| フィールド | 型 | 説明 |
|---|---|---|
| id | integer | アドレスグループID |
| guid | string | アドレスグループGUID |
| name | string | アドレスグループ名 |
| description | string | アドレスグループの説明 |
| count | long | IPアドレス項目数 |
| version | long | アドレスグループのバージョン |
| user_name | string | 作成したユーザー名 |
| user_guid | string | 作成したユーザーGUID |
guidまたはnameオプションを指定した場合(IP項目一覧):
| フィールド | 型 | 説明 |
|---|---|---|
| ip | ipaddr | IPアドレス |
| description | string | IPアドレスの説明 |
エラーコード
パースエラー
| エラーコード | メッセージ | 説明 |
|---|---|---|
| 300330 | no permission for node-ip-blacklist | 管理者権限のないセッションで実行した場合 |
| 300331 | invalid guid format for node-ip-blacklist | guid オプション値が有効なGUID形式でない場合 |
| 300332 | IP blacklist [guid] not found for node-ip-blacklist | guid に対応するアドレスグループが存在しない場合 |
| 300333 | Address group not found by name for node-ip-blacklist. | nameオプションで指定した名前のアドレスグループが存在しない場合。4.0.2609.0以降で使用できるnameオプションに伴うコードで、5.0系(5.0.2605.2まで)には該当しません。 |
| 300334 | Duplicate address group name for node-ip-blacklist. | nameオプションで指定した名前のアドレスグループが複数存在する場合。4.0.2609.0以降で使用できるnameオプションに伴うコードで、5.0系(5.0.2605.2まで)には該当しません。 |
| 300335 | Specify only one of 'guid' or 'name' option in the node-ip-blacklist command. | guidとnameオプションを同時に指定した場合。4.0.2609.0以降で使用できるnameオプションに伴うコードで、5.0系(5.0.2605.2まで)には該当しません。 |
ランタイムエラー
該当なし
説明
node-ip-blacklist コマンドは、データノードに同期されたアドレスグループデータを照会します。このコマンドはデータノードでのみ使用可能であり、管理者権限が必要です。
guidまたはnameオプションを指定すると、該当アドレスグループに登録された個別IPアドレスと説明を照会します。両方のオプションを省略すると、データノードに同期されたすべてのアドレスグループのメタデータ一覧を照会します。
nameオプションでGUIDの代わりにアドレスグループの名前を指定できます。両方のオプションを同時に指定するとエラーになり、nameで指定した名前が存在しない場合や複数のグループと重複する場合もエラーになります。
使用例
-
すべてのアドレスグループ一覧の照会
node-ip-blacklistデータノードに同期されたすべてのアドレスグループの一覧を照会します。
-
特定のアドレスグループのIP項目の照会
node-ip-blacklist guid=550e8400-e29b-41d4-a716-446655440000指定したGUIDに対応するアドレスグループのIPアドレス項目を照会します。
-
名前でアドレスグループのIP項目を照会(4.0系、4.0.2609.0以降)
node-ip-blacklist name=known_attackers指定した名前のアドレスグループのIPアドレス項目を照会します。
変更履歴
| 対象 | 導入リリース |
|---|---|
node-ip-blacklist コマンド | Sonar 4.0以前 |
name オプション | 4.0.2609.0 |