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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
ns: net
preamble: |
The `net` namespace contains functions that can help deal with network-related
lookups and calculations. Some of these functions return specifically-typed
values that contain additional methods useful for formatting or further
calculations.
[RFC 4632]: http://tools.ietf.org/html/rfc4632
[RFC 4291]: http://tools.ietf.org/html/rfc4291
[`inet.af/netaddr`]: https://pkg.go.dev/inet.af/netaddr
funcs:
- name: net.LookupIP
description: |
Resolve an IPv4 address for a given host name. When multiple IP addresses
are resolved, the first one is returned.
pipeline: true
arguments:
- name: name
required: true
description: The hostname to look up. This can be a simple hostname, or a fully-qualified domain name.
examples:
- |
$ gomplate -i '{{ net.LookupIP "example.com" }}'
93.184.216.34
- name: net.LookupIPs
description: |
Resolve all IPv4 addresses for a given host name. Returns an array of strings.
pipeline: true
arguments:
- name: name
required: true
description: The hostname to look up. This can be a simple hostname, or a fully-qualified domain name.
examples:
- |
$ gomplate -i '{{ join (net.LookupIPs "twitter.com") "," }}'
104.244.42.65,104.244.42.193
- name: net.LookupCNAME
description: |
Resolve the canonical name for a given host name. This does a DNS lookup for the
`CNAME` record type. If no `CNAME` is present, a canonical form of the given name
is returned -- e.g. `net.LookupCNAME "localhost"` will return `"localhost."`.
pipeline: true
arguments:
- name: name
required: true
description: The hostname to look up. This can be a simple hostname, or a fully-qualified domain name.
examples:
- |
$ gomplate -i '{{ net.LookupCNAME "www.amazon.com" }}'
d3ag4hukkh62yn.cloudfront.net.
- name: net.LookupSRV
description: |
Resolve a DNS [`SRV` service record](https://en.wikipedia.org/wiki/SRV_record).
This implementation supports the canonical [RFC2782](https://tools.ietf.org/html/rfc2782)
form (i.e. `_Service._Proto.Name`), but other forms are also supported, such as
those served by [Consul's DNS interface](https://www.consul.io/docs/agent/dns.html#standard-lookup).
When multiple records are returned, this function returns the first.
A [`net.SRV`](https://golang.org/pkg/net/#SRV) data structure is returned. The
following properties are available:
- `Target` - _(string)_ the hostname where the service can be reached
- `Port` - _(uint16)_ the service's port
- `Priority`, `Weight` - see [RFC2782](https://tools.ietf.org/html/rfc2782) for details
pipeline: true
arguments:
- name: name
required: true
description: The service name to look up
examples:
- |
$ gomplate -i '{{ net.LookupSRV "_sip._udp.sip.voice.google.com" | toJSONPretty " " }}'
{
"Port": 5060,
"Priority": 10,
"Target": "sip-anycast-1.voice.google.com.",
"Weight": 1
}
- name: net.LookupSRVs
description: |
Resolve a DNS [`SRV` service record](https://en.wikipedia.org/wiki/SRV_record).
This implementation supports the canonical [RFC2782](https://tools.ietf.org/html/rfc2782)
form (i.e. `_Service._Proto.Name`), but other forms are also supported, such as
those served by [Consul's DNS interface](https://www.consul.io/docs/agent/dns.html#standard-lookup).
This function returns all available SRV records.
An array of [`net.SRV`](https://golang.org/pkg/net/#SRV) data structures is
returned. For each element, the following properties are available:
- `Target` - _(string)_ the hostname where the service can be reached
- `Port` - _(uint16)_ the service's port
- `Priority`, `Weight` - see [RFC2782](https://tools.ietf.org/html/rfc2782) for details
pipeline: true
arguments:
- name: name
required: true
description: The hostname to look up. This can be a simple hostname, or a fully-qualified domain name.
rawExamples:
- |
_input.tmpl:_
```
{{ range (net.LookupSRVs "_sip._udp.sip.voice.google.com") -}}
priority={{.Priority}}/port={{.Port}}
{{- end }}
```
```console
$ gomplate -f input.tmpl
priority=10/port=5060
priority=20/port=5060
```
- name: net.LookupTXT
description: |
Resolve a DNS [`TXT` record](https://en.wikipedia.org/wiki/SRV_record).
This function returns all available TXT records as an array of strings.
pipeline: true
arguments:
- name: name
required: true
description: The host name to look up
examples:
- |
$ gomplate -i '{{net.LookupTXT "example.com" | data.ToJSONPretty " " }}'
[
"v=spf1 -all"
]
- name: net.ParseIP
description: |
Parse the given string as an IP address (a `netaddr.IP` from the
[`inet.af/netaddr`](https://pkg.go.dev/inet.af/netaddr) package).
Any of `netaddr.IP`'s methods may be called on the resulting value. See
[the docs](https://pkg.go.dev/inet.af/netaddr) for details.
pipeline: true
arguments:
- name: ip
required: true
description: The IP string to parse. It must be either an IPv4 or IPv6 address.
examples:
- |
$ gomplate -i '{{ (net.ParseIP "192.168.0.1").IsPrivate }}'
true
$ gomplate -i '{{ $ip := net.ParseIP (net.LookupIP "example.com") -}}
{{ $ip.Prefix 12 }}'
93.176.0.0/12
- name: net.ParseIPPrefix
description: |
Parse the given string as an IP address prefix (CIDR) representing an IP
network (a `netaddr.IPPrefix` from the
[`inet.af/netaddr`][] package).
The string can be in the form `"192.168.1.0/24"` or `"2001::db8::/32"`,
the CIDR notations defined in [RFC 4632][] and [RFC 4291][].
Any of `netaddr.IPPrefix`'s methods may be called on the resulting value.
See [the docs][`inet.af/netaddr`] for details.
pipeline: true
arguments:
- name: ipprefix
required: true
description: The IP address prefix to parse. It must represent either an IPv4 or IPv6 prefix, containing a `/`.
examples:
- |
$ gomplate -i '{{ (net.ParseIPPrefix "192.168.0.0/24").Range }}'
192.168.0.0-192.168.0.255
$ gomplate -i '{{ $ip := net.ParseIP (net.LookupIP "example.com") -}}
{{ $net := net.ParseIPPrefix "93.184.0.0/16" -}}
{{ $net.Contains $ip }}'
true
$ gomplate -i '{{ $net := net.ParseIPPrefix "93.184.0.0/12" -}}
{{ $net.Range }}'
93.176.0.0-93.191.255.255
- name: net.ParseIPRange
description: |
Parse the given string as an inclusive range of IP addresses from the same
address family (a `netaddr.IPRange` from the [`inet.af/netaddr`][] package).
The string must contain a hyphen (`-`).
Any of `netaddr.IPRange`'s methods may be called on the resulting value.
See [the docs][`inet.af/netaddr`] for details.
pipeline: true
arguments:
- name: iprange
required: true
description: The IP address range to parse. It must represent either an IPv4 or IPv6 range, containing a `-`.
examples:
- |
$ gomplate -i '{{ (net.ParseIPRange "192.168.0.0-192.168.0.255").To }}'
192.168.0.255
$ gomplate -i '{{ $range := net.ParseIPRange "1.2.3.0-1.2.3.233" -}}
{{ $range.Prefixes }}'
[1.2.3.0/25 1.2.3.128/26 1.2.3.192/27]
|
