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

{
  "anchor": "ip_ntop",
  "name": "ip_ntop",
  "category": "IP",
  "description": "Converts IPv4 and IPv6 addresses from binary to text form.\n\nThis behavior mimics [inet_ntop](https://linux.die.net/man/3/inet_ntop).",
  "arguments": [
    {
      "name": "value",
      "description": "The binary data to convert from.\nFor IPv4 addresses, it must be 4 bytes (32 bits) long.\nFor IPv6 addresses, it must be 16 bytes (128 bits) long.",
      "required": true,
      "type": [
        "string"
      ]
    }
  ],
  "return": {
    "types": [
      "string"
    ]
  },
  "internal_failure_reasons": [
    "`value` must be of length 4 or 16 bytes."
  ],
  "examples": [
    {
      "title": "Convert IPv4 address from bytes after decoding from Base64",
      "source": "ip_ntop!(decode_base64!(\"wKgAAQ==\"))",
      "return": "192.168.0.1"
    },
    {
      "title": "Convert IPv6 address from bytes after decoding from Base64",
      "source": "ip_ntop!(decode_base64!(\"IAENuIWjAAAAAIouA3BzNA==\"))",
      "return": "2001:db8:85a3::8a2e:370:7334"
    }
  ],
  "notices": [
    "The binary data for this function is not easily printable. However, the results from\nfunctions such as `decode_base64` or `decode_percent` can still be used correctly."
  ],
  "pure": true
}