Update network resource docs

vatesfr · Sep 16, 2023 · 12b19fe · 12b19fe
1 parent cf46457
commit 12b19fe
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 13 deletions.
diff --git a/docs/resources/network.md b/docs/resources/network.md
@@ -17,16 +17,17 @@ data "xenorchestra_host" "host1" {
   name_label = "Your host"
 }
 
-data "xenorchestra_pif" "pif" {
-  device = "eth0"
-  vlan = -1
-  host_id = data.xenorchestra_host.host1.id
+# Create a single server network private network
+resource "xenorchestra_network" "private_network" {
+  name_label = "new network name"
+  pool_id = data.xenorchestra_host.host1.pool_id
 }
 
-resource "xenorchestra_network" "network" {
+# Create a network with a 22 VLAN tag from the eth0 device
+resource "xenorchestra_network" "vlan_network" {
   name_label = "new network name"
   pool_id = data.xenorchestra_host.host1.pool_id
-  pif_id = data.xenorchestra_pif.pif.id
+  source_pif_device = "eth0"
   vlan = 22
 }
 ```
@@ -46,7 +47,7 @@ resource "xenorchestra_network" "network" {
 - `mtu` (Number) The MTU of the network. Defaults to `1500` if unspecified.
 - `name_description` (String)
 - `nbd` (Boolean) Whether the network should use a network block device. Defaults to `false` if unspecified.
-- `pif_id` (String) The pif (uuid) that should be used for this network.
+- `source_pif_device` (String) The PIF device (eth0, eth1, etc) that will be used as an input during network creation. This parameter is required if a vlan is specified.
 - `vlan` (Number) The vlan to use for the network. Defaults to `0` meaning no VLAN.
 
 ### Read-Only

diff --git a/examples/resources/xenorchestra_network/resource.tf b/examples/resources/xenorchestra_network/resource.tf
@@ -2,15 +2,16 @@ data "xenorchestra_host" "host1" {
   name_label = "Your host"
 }
 
-data "xenorchestra_pif" "pif" {
-  device = "eth0"
-  vlan = -1
-  host_id = data.xenorchestra_host.host1.id
+# Create a single server network private network
+resource "xenorchestra_network" "private_network" {
+  name_label = "new network name"
+  pool_id = data.xenorchestra_host.host1.pool_id
 }
 
-resource "xenorchestra_network" "network" {
+# Create a network with a 22 VLAN tag from the eth0 device
+resource "xenorchestra_network" "vlan_network" {
   name_label = "new network name"
   pool_id = data.xenorchestra_host.host1.pool_id
-  pif_id = data.xenorchestra_pif.pif.id
+  source_pif_device = "eth0"
   vlan = 22
 }