matchblackip()

matchblackip()関数は指定したアドレスグループに特定のIPアドレスが含まれているか確認します。

構文

matchblackip(STR_GUID, IP_ADDR_EXPR)

パラメーター

STR_GUID
アドレスグループのGUIDです。有効なアドレスグループ識別子である必要があります。存在しないGUIDを指定するとクエリのパース段階でエラーが発生します。
IP_ADDR_EXPR
IPアドレス式です。IPv4アドレス型またはIPv4形式の文字列のみ受け付けます。受け付けない型の場合はfalseを返します。

説明

matchblackip()関数は指定したアドレスグループにIP_ADDR_EXPRの値が含まれている場合はtrue、含まれていない場合はfalseを返します。

IP_ADDR_EXPRの値がnullの場合はfalseを返します。IPアドレス型の場合は文字列に変換してからアドレスグループで検索します。IPv4アドレスまたはIPv4形式の文字列でない場合はfalseを返します。

アドレスグループはSonarウェブコンソールのポリシー > アドレスグループメニューで管理します。

エラーコード

該当なし

使用例

  1. src_ipフィールドの値が指定したアドレスグループに含まれているか確認する

    json "{'src_ip': '192.0.2.1'}"
    | eval result = matchblackip("550e8400-e29b-41d4-a716-446655440000", src_ip)
    | # result: false
    
  2. IP_ADDR_EXPRの値がnullの場合

    json "{'src_ip': null}"
    | eval result = matchblackip("550e8400-e29b-41d4-a716-446655440000", null)
    | # result: false
    
  3. IP_ADDR_EXPRの値がIPv4以外の型の場合

    json "{'src_ip': 12345}"
    | eval result = matchblackip("550e8400-e29b-41d4-a716-446655440000", src_ip)
    | # result: false
    

互換性

matchblackip()関数はSonar 4.0以前のバージョンから提供されています。