Skip to content

Commit 0e754f0

Browse files
Adding documentation for md5 auth key (#10547) (#7306)
[upstream:d24fc59d98f88aa9eb7c59176ff0c0a2f0026fb8] Signed-off-by: Modular Magician <[email protected]>
1 parent d093b7b commit 0e754f0

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

website/docs/r/compute_router_peer.html.markdown

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,25 @@ resource "google_compute_router_peer" "peer" {
183183
}
184184
```
185185

186+
## Example Usage - Router Peer md5 authentication key
187+
188+
189+
```hcl
190+
resource "google_compute_router_peer" "foobar" {
191+
name = "%s-peer"
192+
router = google_compute_router.foobar.name
193+
region = google_compute_router.foobar.region
194+
peer_asn = 65515
195+
advertised_route_priority = 100
196+
interface = google_compute_router_interface.foobar.name
197+
peer_ip_address = "169.254.3.2"
198+
md5_authentication_key {
199+
name = "%s-peer-key"
200+
key = "%s-peer-key-value"
201+
}
202+
}
203+
```
204+
186205
## Argument Reference
187206

188207
The following arguments are supported:
@@ -316,6 +335,8 @@ The following arguments are supported:
316335
* `project` - (Optional) The ID of the project in which the resource belongs.
317336
If it is not provided, the provider project is used.
318337

338+
* `md5_authentication_key` - (Optional) Configuration for MD5 authentication on the BGP session.
339+
Structure is [documented below](#nested_md5_authentication_key).
319340

320341
<a name="nested_advertised_ip_ranges"></a>The `advertised_ip_ranges` block supports:
321342

@@ -361,6 +382,16 @@ The following arguments are supported:
361382
BFD declares that a peer is unavailable. If set, the value must
362383
be a value between 5 and 16.
363384

385+
<a name="nested_md5_authentication_key"></a>The `md5_authentication_key` block supports:
386+
387+
* `name` -
388+
(Required)
389+
Name used to identify the key. Must be unique within a router. Must comply with RFC1035.
390+
391+
* `key` -
392+
(Required, Input Only)
393+
The MD5 authentication key for this BGP peer. Maximum length is 80 characters. Can only contain printable ASCII characters
394+
364395
## Attributes Reference
365396

366397
In addition to the arguments listed above, the following computed attributes are exported:

0 commit comments

Comments
 (0)