Skip to content

Commit 98a88bd

Browse files
r-patanger-patange
committed
docs(power): add instance network DS docs
Add docs for d/pi_instance_network and d/pi_instance_networks with example usage, arguments, and attributes.
1 parent 691de9b commit 98a88bd

File tree

2 files changed

+117
-0
lines changed

2 files changed

+117
-0
lines changed

‎website/docs/d/pi_instance_network.html.markdown‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
subcategory: "Power Systems"
3+
layout: "ibm"
4+
page_title: "IBM: pi_instance_network"
5+
description: |-
6+
Retrieve information about a single network attached to a Power Systems Virtual Server instance.
7+
---
8+
9+
# ibm_pi_instance_network
10+
11+
Retrieve information about a specific network on a Power Systems Virtual Server instance. For more information about Power Virtual Server instances, see [getting started with IBM Power Systems Virtual Servers](https://cloud.ibm.com/docs/power-iaas?topic=power-iaas-getting-started).
12+
13+
## Example Usage
14+
15+
```terraform
16+
data "ibm_pi_instance_network" "ds_instance_network" {
17+
pi_cloud_instance_id = "49fba6c9-23f8-40bc-9899-aca322ee7d5b"
18+
pi_instance_id = "cea6651a-bc0a-4438-9f8a-a0770b112ebb"
19+
pi_network_id = "52b7c0b1-1df1-495a-9c2d-8b7a6c5ef9aa"
20+
}
21+
```
22+
23+
### Notes
24+
25+
- Please find [supported Regions](https://cloud.ibm.com/apidocs/power-cloud#endpoint) for endpoints.
26+
- If a Power cloud instance is provisioned at `lon04`, The provider level attributes should be as follows:
27+
- `region` - `lon`
28+
- `zone` - `lon04`
29+
30+
Example usage:
31+
32+
```terraform
33+
provider "ibm" {
34+
region = "lon"
35+
zone = "lon04"
36+
}
37+
```
38+
39+
## Argument Reference
40+
41+
Review the argument references that you can specify for your data source.
42+
43+
- `pi_cloud_instance_id` - (Required, String) The GUID of the service instance associated with an account.
44+
- `pi_instance_id` - (Required, String) The unique identifier or name of the instance.
45+
- `pi_network_id` - (Required, String) The unique identifier or name of the instance.
46+
47+
## Attribute Reference
48+
49+
In addition to all argument reference list, you can access the following attribute references after your data source is created.
50+
51+
- `id` - (String) The unique identifier of the data source in the form <pi_cloud_instance_id>/<pi_instance_id>/<pi_network_id>.
52+
- `external_ip` - (String) TThe external IP address of the network (for pub-VLAN networks).
53+
- `ip_address` - (String) The IP address of the network interface.
54+
- `mac_address` - (String) The MAC address of the network interface.
55+
- `network_id` - (String) The network ID.
56+
- `network_interface_id` - (String) ID of the network interface.
57+
- `network_name` - (String) The network name.
58+
- `network_security_group_ids` - (List) IDs of the network security groups that the network interface is a member of.
59+
- `network_security_groups_href` - (List) Links to the network security groups that the network interface is a member of.
60+
- `type` - (String) The address type (for example, fixed or dynamic).
61+
- `href` - (String) Link to this PVM instance network.
62+
- `version` - (Float) Version of the network information.

‎website/docs/d/pi_instance_networks.html.markdown‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
subcategory: "Power Systems"
3+
layout: "ibm"
4+
page_title: "IBM: pi_instance_networks"
5+
description: |-
6+
Retrieve information about all networks attached to a Power Systems Virtual Server instance.
7+
---
8+
9+
# ibm_pi_instance_networks
10+
11+
Retrieve information about all networks on a Power Systems Virtual Server instance. For more information about Power Virtual Server instances, see [getting started with IBM Power Systems Virtual Servers](https://cloud.ibm.com/docs/power-iaas?topic=power-iaas-getting-started).
12+
13+
## Example Usage
14+
15+
```terraform
16+
data "ibm_pi_instance_networks" "ds_instance_networks" {
17+
pi_cloud_instance_id = "49fba6c9-23f8-40bc-9899-aca322ee7d5b"
18+
pi_instance_id = "cea6651a-bc0a-4438-9f8a-a0770b112ebb"
19+
}
20+
```
21+
22+
### Notes
23+
24+
- Please find [supported Regions](https://cloud.ibm.com/apidocs/power-cloud#endpoint) for endpoints.
25+
- If a Power cloud instance is provisioned at `lon04`, The provider level attributes should be as follows:
26+
- `region` - `lon`
27+
- `zone` - `lon04`
28+
29+
Example usage:
30+
31+
```terraform
32+
provider "ibm" {
33+
region = "lon"
34+
zone = "lon04"
35+
}
36+
```
37+
38+
## Argument Reference
39+
40+
Review the argument references that you can specify for your data source.
41+
42+
- `pi_cloud_instance_id` - (Required, String) The GUID of the service instance associated with an account.
43+
- `pi_instance_id` - (Required, String) The unique identifier or name of the instance.
44+
45+
## Attribute Reference
46+
47+
In addition to all argument reference list, you can access the following attribute references after your data source is created.
48+
49+
- `id` - (String) The unique identifier of the data source in the form <pi_cloud_instance_id>/<pi_instance_id>.
50+
- `networks` - (List) List of networks associated with this instance.
51+
Nested scheme for networks:
52+
- `external_ip` - (String) The external IP address of the network (for pub-VLAN networks).
53+
- `ip_address` - (String) The IP address of the network interface.
54+
- `mac_address` - (String) The MAC address of the network interface.
55+
- `network_id` - (String) The network ID.

0 commit comments

Comments
 (0)