You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Gets information about IP managed by IPAM service. IPAM service is used for dhcp bundled in VPCs' private networks.
8
+
Gets information about IP addresses managed by Scaleway's IP Address Management (IPAM) service. IPAM is used for the DHCP bundled with VPC Private Networks.
9
+
10
+
For more information about IPAM, see the main [documentation](https://www.scaleway.com/en/docs/network/vpc/concepts/#ipam).
9
11
10
12
## Examples
11
13
@@ -20,7 +22,7 @@ data "scaleway_ipam_ip" "by_id" {
20
22
21
23
### Instance Private Network IP
22
24
23
-
Get Instance IP in a private network.
25
+
Get an Instance's IP on a Private Network.
24
26
25
27
```terraform
26
28
# Connect your instance to a private network using a private nic.
@@ -77,19 +79,19 @@ data "scaleway_ipam_ip" "by_name" {
77
79
78
80
## Argument Reference
79
81
80
-
-`ipam_ip_id` - (Optional) The IPAM IP ID. Cannot be used with the rest of the arguments.
82
+
-`ipam_ip_id` - (Optional) The IPAM IP ID. Cannot be used with any other arguments.
81
83
82
-
-`type` - (Optional) The type of IP to search for (ipv4, ipv6). Cannot be used with `ipam_ip_id`.
84
+
-`type` - (Optional) The type of IP to search for (`ipv4` or `ipv6`). Cannot be used with `ipam_ip_id`.
83
85
84
-
-`private_network_id` - (Optional) The ID of the private network the IP belong to. Cannot be used with `ipam_ip_id`.
86
+
-`private_network_id` - (Optional) The ID of the Private Network the IP belongs to. Cannot be used with `ipam_ip_id`.
85
87
86
88
-`resource` - (Optional) Filter by resource ID, type or name. Cannot be used with `ipam_ip_id`.
87
89
If specified, `type` is required, and at least one of `id` or `name` must be set.
88
-
- `id` - The ID of the resource that the IP is bound to.
89
-
- `type` - The type of the resource to get the IP from. [Documentation](https://pkg.go.dev/github.com/scaleway/scaleway-sdk-go@master/api/ipam/v1#pkg-constants) with type list.
90
-
- `name` - The name of the resource to get the IP from.
90
+
- `id` - The ID of the resource that the IP is attached to.
91
+
- `type` - The type of the resource the IP is attached to. [Documentation](https://pkg.go.dev/github.com/scaleway/scaleway-sdk-go@master/api/ipam/v1#pkg-constants) with type list.
92
+
- `name` - The name of the resource the IP is attached to.
91
93
92
-
-`mac_address` - (Optional) The Mac Address linked to the IP. Cannot be used with `ipam_ip_id`.
94
+
-`mac_address` - (Optional) The MAC address linked to the IP. Cannot be used with `ipam_ip_id`.
93
95
94
96
-`region` - (Defaults to [provider](../index.md#zone)`region`) The [region](../guides/regions_and_zones.md#regions) in which the IP exists.
95
97
@@ -100,14 +102,14 @@ If specified, `type` is required, and at least one of `id` or `name` must be set
100
102
101
103
-`attached` - (Optional) Defines whether to filter only for IPs which are attached to a resource. Cannot be used with `ipam_ip_id`.
102
104
103
-
-`project_id` - (Defaults to [provider](../index.md#project_id)`project_id`) The ID of the project the IP is associated with.
105
+
-`project_id` - (Defaults to [provider](../index.md#project_id)`project_id`) The ID of the Project the IP is associated with.
104
106
105
-
-`organization_id` - (Defaults to [provider](../index.md#organization_id)`organization_id`) The ID of the organization the IP is in.
107
+
-`organization_id` - (Defaults to [provider](../index.md#organization_id)`organization_id`) The ID of the Organization the IP is in.
106
108
107
109
## Attributes Reference
108
110
109
111
In addition to all above arguments, the following attributes are exported:
110
112
111
113
-`id` - The ID of the IP in IPAM.
112
114
-`address` - The IP address.
113
-
-`address_cidr` - the IP address with a CIDR notation.
115
+
-`address_cidr` - the IP address in CIDR notation.
Gets information about multiple IPs managed by IPAM service.
8
+
Gets information about multiple IP addresses managed by Scaleway's IP Address Management (IPAM) service.
9
+
10
+
For more information about IPAM, see the main [documentation](https://www.scaleway.com/en/docs/network/vpc/concepts/#ipam).
9
11
10
12
## Examples
11
13
@@ -54,49 +56,49 @@ data "scaleway_ipam_ips" "by_type_and_resource" {
54
56
55
57
## Argument Reference
56
58
57
-
-`type` - (Optional) The type of IP used as filter (ipv4, ipv6).
59
+
-`type` - (Optional) The type of IP to filter for (`ipv4` or `ipv6`).
58
60
59
-
-`private_network_id` - (Optional) The ID of the private network used as filter.
61
+
-`private_network_id` - (Optional) The ID of the Private Network to filter for.
60
62
61
-
-`resource` - (Optional) Filter by resource ID, type or name.
62
-
-`id` - The ID of the resource that the IP is bound to.
63
-
-`type` - The type of the resource to get the IP from. [Documentation](https://pkg.go.dev/github.com/scaleway/scaleway-sdk-go@master/api/ipam/v1#pkg-constants) with type list.
64
-
-`name` - The name of the resource to get the IP from.
63
+
-`resource` - (Optional) Filter for a resource attached to the IP, using resource ID, type or name.
64
+
-`id` - The ID of the attached resource.
65
+
-`type` - The type of the attached resource. [Documentation](https://pkg.go.dev/github.com/scaleway/scaleway-sdk-go@master/api/ipam/v1#pkg-constants) with type list.
66
+
-`name` - The name of the attached resource.
65
67
66
-
-`mac_address` - (Optional) The Mac Address used as filter.
68
+
-`mac_address` - (Optional) The linked MAC address to filter for.
67
69
68
-
-`tags` (Optional) The tags used as filter.
70
+
-`tags` (Optional) The IP tags to filter for.
69
71
70
72
-`attached` - (Optional) Defines whether to filter only for IPs which are attached to a resource.
71
73
72
74
-`zonal` - (Optional) Only IPs that are zonal, and in this zone, will be returned.
73
75
74
-
-`region` - (Optional) The region used as filter.
76
+
-`region` - (Optional) The region to filter for.
75
77
76
-
-`project_id` - (Optional) The ID of the project used as filter.
78
+
-`project_id` - (Optional) The ID of the Project to filter for.
77
79
78
-
-`organization_id` - (Optional) The ID of the organization used as filter.
80
+
-`organization_id` - (Optional) The ID of the Organization to filter for.
79
81
80
82
## Attributes Reference
81
83
82
84
In addition to all above arguments, the following attributes are exported:
83
85
84
-
-`id` - The region of the IPS
85
-
-`ips` - List of found IPs
86
+
-`id` - The region of the IPs.
87
+
-`ips` - List of found IPs.
86
88
-`id` - The ID of the IP.
87
89
88
-
~> **Important:** IPAM IPs' IDs are [regional](../guides/regions_and_zones.md#resource-ids), which means they are of the form `{region}/{id}`, e.g. `fr-par/11111111-1111-1111-1111-111111111111`
90
+
~> **Important:** IPAM IP IDs are [regional](../guides/regions_and_zones.md#resource-ids), which means they are of the form `{region}/{id}`, e.g. `fr-par/11111111-1111-1111-1111-111111111111`
89
91
90
-
-`address` - The Scaleway internal IP address of the server.
91
-
-`resource` - The list of public IPs of the server.
92
+
-`address` - The Scaleway internal IP address of the resource.
93
+
-`resource` - The list of public IPs attached to the resource.
92
94
-`id` - The ID of the resource.
93
95
-`type` - The type of resource.
94
-
-`mac_address` - The mac address.
96
+
-`mac_address` - The associated MAC address.
95
97
-`name` - The name of the resource.
96
98
-`tags` - The tags associated with the IP.
97
99
-`created_at` - The date and time of the creation of the IP.
98
100
-`updated_at` - The date and time of the last update of the IP.
99
-
-`zone` - The [zone](../guides/regions_and_zones.md#zones)in which the IP is.
100
-
-`region` - The [region](../guides/regions_and_zones.md#regions)in which the IP is.
101
-
-`project_id` - The ID of the project the server is associated with.
101
+
-`zone` - The [zone](../guides/regions_and_zones.md#zones)of the IP.
102
+
-`region` - The [region](../guides/regions_and_zones.md#regions)of the IP.
103
+
-`project_id` - The ID of the Project the resource is associated with.
For more information, see the [main documentation](https://www.scaleway.com/en/docs/network/load-balancer/concepts/#load-balancers) or [API documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-load-balancer-list-load-balancers).
11
+
10
12
## Example Usage
11
13
12
14
```hcl
@@ -23,24 +25,24 @@ data "scaleway_lb" "by_id" {
23
25
24
26
## Argument Reference
25
27
26
-
-`name` - (Optional) The load balancer name.
28
+
-`name` - (Optional) The Load Balancer name.
27
29
28
-
-`ip_id` - (Optional) The load balancer IP ID.
30
+
-`ip_id` - (Optional) The Load Balancer IP ID.
29
31
30
-
-`project_id` - (Optional) The ID of the project the LB is associated with.
32
+
-`project_id` - (Optional) The ID of the Project the Load Balancer is associated with.
31
33
32
34
## Attributes Reference
33
35
34
36
In addition to all arguments above, the following attributes are exported:
35
37
36
-
-`id` - The ID of the load-balancer.
38
+
-`id` - The ID of the Load Balancer.
37
39
38
-
~> **Important:** Load-Balancers' IDs are [zoned](../guides/regions_and_zones.md#resource-ids), which means they are of the form `{zone}/{id}`, e.g. `fr-par-1/11111111-1111-1111-1111-111111111111`
40
+
~> **Important:** Load Balancer IDs are [zoned](../guides/regions_and_zones.md#resource-ids), which means they are of the form `{zone}/{id}`, e.g. `fr-par-1/11111111-1111-1111-1111-111111111111`
39
41
40
-
-`ip_address` - The load-balancer public IP Address.
42
+
-`ip_address` - The Load Balancer public IP address.
41
43
42
-
-`type` - The type of the load-balancer.
44
+
-`type` - The Load Balancer type.
43
45
44
-
-`tags` - The tags associated with the load-balancer.
46
+
-`tags` - The tags associated with the Load Balancer.
45
47
46
-
-`zone` - (Defaults to [provider](../index.md#zone)`zone`) The [zone](../guides/regions_and_zones.md#zones) in which the LB exists.
48
+
-`zone` - (Defaults to [provider](../index.md#zone)`zone`) The [zone](../guides/regions_and_zones.md#zones) in which the Load Balancer exists.
0 commit comments