docs: Improve docs

smutel · Oct 31, 2020 · 7875f6d · 7875f6d
1 parent 8798e24
commit 7875f6d
Show file tree

Hide file tree

Showing 16 changed files with 95 additions and 15 deletions.
diff --git a/docs/data-sources/dcim_platform.md b/docs/data-sources/dcim_platform.md
@@ -0,0 +1,21 @@
+# netbox\_dcim\_platform Data Source
+
+Get info about dcim platform from netbox.
+
+## Example Usage
+
+```hcl
+data "netbox_dcim_platform" "platform_test" {
+  slug = "TestPlatform"
+}
+```
+
+## Argument Reference
+
+The following arguments are supported:
+* ``slug`` - (Required) The slug of the dcim platform.
+
+## Attributes Reference
+
+In addition to the above arguments, the following attributes are exported:
+* ``id`` - The id (ref in Netbox) of this object.
diff --git a/docs/data-sources/dcim_site.md b/docs/data-sources/dcim_site.md
@@ -1,6 +1,6 @@
 # netbox\_dcim\_site Data Source
 
-Get info about dcim site in the netbox provider.
+Get info about dcim site from netbox.
 
 ## Example Usage
 

diff --git a/docs/data-sources/ipam_ip_addresses.md b/docs/data-sources/ipam_ip_addresses.md
@@ -1,6 +1,6 @@
 # netbox\_ipam\_ip\_addresses Data Source
 
-Get info about ipam IP addresses in the netbox provider.
+Get info about ipam IP addresses from netbox.
 
 ## Example Usage
 

diff --git a/docs/data-sources/ipam_role.md b/docs/data-sources/ipam_role.md
@@ -1,6 +1,6 @@
 # netbox\_ipam\_role Data Source
 
-Get info about ipam role in the netbox provider.
+Get info about ipam role from netbox.
 
 ## Example Usage
 

diff --git a/docs/data-sources/ipam_vlan.md b/docs/data-sources/ipam_vlan.md
@@ -1,6 +1,6 @@
 # netbox\_ipam\_vlan Data Source
 
-Get info about ipam vlan in the netbox provider.
+Get info about ipam vlan from netbox.
 
 ## Example Usage
 

diff --git a/docs/data-sources/ipam_vlan_group.md b/docs/data-sources/ipam_vlan_group.md
@@ -1,6 +1,6 @@
 # netbox\_ipam\_vlan\_group Data Source
 
-Get info about ipam vlan group in the netbox provider.
+Get info about ipam vlan group from netbox.
 
 ## Example Usage
 

diff --git a/docs/data-sources/tenancy_tenant.md b/docs/data-sources/tenancy_tenant.md
@@ -1,6 +1,6 @@
 # netbox\_tenancy\_tenant Data Source
 
-Get info about tenancy tenant in the netbox provider.
+Get info about tenancy tenant from netbox.
 
 ## Example Usage
 

diff --git a/docs/data-sources/tenancy_tenant_group.md b/docs/data-sources/tenancy_tenant_group.md
@@ -1,6 +1,6 @@
 # netbox\_tenancy\_tenant\_group Data Source
 
-Get info about tenancy tenant groups in the netbox provider.
+Get info about tenancy tenant groups from netbox.
 
 ## Example Usage
 

diff --git a/docs/data-sources/virtualization_cluster.md b/docs/data-sources/virtualization_cluster.md
@@ -0,0 +1,21 @@
+# netbox\_virtualization\_cluster Data Source
+
+Get info about vitualization cluster from netbox.
+
+## Example Usage
+
+```hcl
+data "netbox_virtualization_cluster" "cluster_test" {
+  name = "TestCluster"
+}
+```
+
+## Argument Reference
+
+The following arguments are supported:
+* ``name`` - (Required) The name of the cluster.
+
+## Attributes Reference
+
+In addition to the above arguments, the following attributes are exported:
+* ``id`` - The id (ref in Netbox) of this object.
diff --git a/docs/resources/ipam_ip_addresses.md b/docs/resources/ipam_ip_addresses.md
@@ -1,6 +1,6 @@
 # netbox\_ipam\_ip\_addresses Resource
 
-Manages an ip address within Netbox.
+Manage an ip address within Netbox.
 
 ## Example Usage
 
@@ -23,7 +23,9 @@ The following arguments are supported:
 * ``address`` - (Required) The IP address (with mask) used for this object.
 * ``description`` - (Optional) The description of this object.
 * ``dns_name`` - (Optional) The DNS name of this object.
-* ``interface_id`` - (Optional) The ID of the interface where this object is attached to.
+* ``object_id`` - (Optional) The ID of the object where this object is attached to.
+* ``object_type`` - (Optional) The object type among virtualization.vminterface
+or dcim.interface (virtualization.vminterface by default)
 * ``nat_inside_id`` - (Optional) The ID of the NAT inside of this object.
 * ``nat_outside_id`` - (Optional) The ID of the NAT outside of this object.
 * ``role`` - (Optional) The role among loopback, secondary, anycast, vip, vrrp, hsrp, glbp, carp of this object.

diff --git a/docs/resources/ipam_prefix.md b/docs/resources/ipam_prefix.md
@@ -1,6 +1,6 @@
 # netbox\_ipam\_prefix Resource
 
-Manages a prefix within Netbox.
+Manage a prefix within Netbox.
 
 ## Example Usage
 

diff --git a/docs/resources/ipam_vlan.md b/docs/resources/ipam_vlan.md
@@ -1,6 +1,6 @@
 # netbox\_ipam\_vlan Resource
 
-Manages a vlan within Netbox.
+Manage a vlan within Netbox.
 
 ## Example Usage
 

diff --git a/docs/resources/ipam_vlan_group.md b/docs/resources/ipam_vlan_group.md
@@ -1,7 +1,6 @@
 # netbox\_ipam\_vlan\_group Resource
 
-Manages a vlan group within Netbox.
-
+Manage a vlan group within Netbox.
 
 ## Example Usage
 

diff --git a/docs/resources/tenancy_tenant.md b/docs/resources/tenancy_tenant.md
@@ -1,6 +1,6 @@
 # netbox\_tenancy\_tenant Resource
 
-Manages a tenant within Netbox.
+Manage a tenant within Netbox.
 
 ## Example Usage
 

diff --git a/docs/resources/virtualization_interface.md b/docs/resources/virtualization_interface.md
@@ -0,0 +1,37 @@
+# netbox\_virtualization\_interface Resource
+
+Manage an interface resource within Netbox.
+
+## Example Usage
+
+```hcl
+resource "netbox_virtualization_interface" "interface_test" {
+  name = "default"
+  virtualmachine_id = netbox_virtualization_vm.vm_test.id
+  mac_address = "AA:AA:AA:AA:AA:AA"
+  mtu = 1500
+  description = "Interface de test"
+}
+```
+
+## Argument Reference
+
+The following arguments are supported:
+* ``description`` - (Optional) Description for this object.
+* ``enabled`` - (Optional) true or false (true by default).
+* ``mac_address`` - (Optional) Mac address for this object.
+* ``mode`` - (Optional) The mode among access, tagged, tagged-all.
+* ``mtu`` - (Optional) The MTU between 1 and 65536 for this object.
+* ``name`` - (Required) The name for this object.
+* ``tagged_vlans`` - (Optional) List of vlan id tagged for this interface
+* ``untagged_vlans`` - (Optional) Vlan id untagged for this interface
+* ``virtualmachine_id`` - (Required) ID of the virtual machine where this object
+is attached
+The ``tag`` block supports:
+* ``name`` - (Required) Name of the existing tag to associate with this resource.
+* ``slug`` - (Required) Slug of the existing tag to associate with this resource.
+
+## Attributes Reference
+
+In addition to the above arguments, the following attributes are exported:
+* ``id`` - The id (ref in Netbox) of this object.
diff --git a/docs/resources/virtualization_vm.md b/docs/resources/virtualization_vm.md
@@ -1,6 +1,6 @@
 # netbox\_virtualization\_vm Resource
 
-Manages a virtual machine resource within Netbox.
+Manage a virtual machine resource within Netbox.
 
 ## Example Usage