vrl 0.32.0

Vector Remap Language
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

{
  "anchor": "ip_cidr_contains",
  "name": "ip_cidr_contains",
  "category": "IP",
  "description": "Determines whether the `ip` is contained in the block referenced by the `cidr`.",
  "arguments": [
    {
      "name": "cidr",
      "description": "The CIDR mask (v4 or v6).",
      "required": true,
      "type": [
        "string",
        "array"
      ]
    },
    {
      "name": "value",
      "description": "The IP address (v4 or v6).",
      "required": true,
      "type": [
        "string"
      ]
    }
  ],
  "return": {
    "types": [
      "boolean"
    ]
  },
  "internal_failure_reasons": [
    "`cidr` is not a valid CIDR.",
    "`ip` is not a valid IP address."
  ],
  "examples": [
    {
      "title": "IPv4 contains CIDR",
      "source": "ip_cidr_contains!(\"192.168.0.0/16\", \"192.168.10.32\")",
      "return": true
    },
    {
      "title": "IPv4 is private",
      "source": "ip_cidr_contains!([\"10.0.0.0/8\", \"172.16.0.0/12\", \"192.168.0.0/16\"], \"192.168.10.32\")",
      "return": true
    },
    {
      "title": "IPv6 contains CIDR",
      "source": "ip_cidr_contains!(\"2001:4f8:4:ba::/64\", \"2001:4f8:4:ba:2e0:81ff:fe22:d1f1\")",
      "return": true
    },
    {
      "title": "Not in range",
      "source": "ip_cidr_contains!(\"192.168.0.0/24\", \"192.168.10.32\")",
      "return": false
    },
    {
      "title": "Invalid address",
      "source": "ip_cidr_contains!(\"192.168.0.0/24\", \"INVALID\")",
      "raises": "function call error for \"ip_cidr_contains\" at (0:46): unable to parse IP address: invalid IP address syntax"
    }
  ],
  "pure": true
}