Added data.vlan_groupS resource and added id field to data.vlan_group

Author: hp197

docs/data-sources/vlan_group.md

@@ -18,11 +18,16 @@ data "netbox_vlan_group" "example1" {
   name = "example1"
 }
 
-# Get VLAN group by stub
+# Get VLAN group by slug
 data "netbox_vlan_group" "example2" {
   slug = "example2"
 }
 
+# Get VLAN group by ID
+data "netbox_vlan_group" "example_id" {
+  id = 1
+}
+
 # Get VLAN group by name and scope_type/id
 data "netbox_vlan_group" "example3" {
   name       = "example"
@@ -36,10 +41,11 @@ data "netbox_vlan_group" "example3" {
 
 ### Optional
 
-- `name` (String) At least one of `name`, `slug` or `scope_type` must be given.
+- `id` (Number) The ID of the VLAN group.
+- `name` (String) At least one of `id`, `name`, `slug` or `scope_type` must be given.
 - `scope_id` (Number) Required when `scope_type` is set.
-- `scope_type` (String) Valid values are `dcim.location`, `dcim.site`, `dcim.sitegroup`, `dcim.region`, `dcim.rack`, `virtualization.cluster` and `virtualization.clustergroup`. At least one of `name`, `slug` or `scope_type` must be given.
-- `slug` (String) At least one of `name`, `slug` or `scope_type` must be given.
+- `scope_type` (String) Valid values are `dcim.location`, `dcim.site`, `dcim.sitegroup`, `dcim.region`, `dcim.rack`, `virtualization.cluster` and `virtualization.clustergroup`. At least one of `id`, `name`, `slug` or `scope_type` must be given.
+- `slug` (String) At least one of `id`, `name`, `slug` or `scope_type` must be given.
 
 ### Read-Only
 

docs/data-sources/vlan_groups.md

@@ -0,0 +1,90 @@
+---
+# generated by https://github.com/fbreckle/terraform-plugin-docs
+page_title: "netbox_vlan_groups Data Source - terraform-provider-netbox"
+subcategory: "IP Address Management (IPAM)"
+description: |-
+  
+---
+
+# netbox_vlan_groups (Data Source)
+
+
+
+## Example Usage
+
+```terraform
+# Get all VLAN groups
+data "netbox_vlan_groups" "all" {
+}
+
+# Get VLAN groups by name
+data "netbox_vlan_groups" "example" {
+  filter {
+    name  = "name"
+    value = "example"
+  }
+}
+
+# Get VLAN groups by slug
+data "netbox_vlan_groups" "by_slug" {
+  filter {
+    name  = "slug"
+    value = "example-slug"
+  }
+}
+
+# Get VLAN groups by scope
+data "netbox_vlan_groups" "by_scope" {
+  filter {
+    name  = "scope_type"
+    value = "dcim.site"
+  }
+  filter {
+    name  = "scope_id"
+    value = "1"
+  }
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Optional
+
+- `filter` (Block Set) (see [below for nested schema](#nestedblock--filter))
+- `limit` (Number) Defaults to `0`.
+
+### Read-Only
+
+- `id` (String) The ID of this resource.
+- `vlan_groups` (List of Object) (see [below for nested schema](#nestedatt--vlan_groups))
+
+<a id="nestedblock--filter"></a>
+### Nested Schema for `filter`
+
+Required:
+
+- `name` (String)
+- `value` (String)
+
+
+<a id="nestedatt--vlan_groups"></a>
+### Nested Schema for `vlan_groups`
+
+Read-Only:
+
+- `cluster_id` (Number)
+- `clustergroup_id` (Number)
+- `description` (String)
+- `id` (Number)
+- `location_id` (Number)
+- `max_vid` (Number)
+- `min_vid` (Number)
+- `name` (String)
+- `region_id` (Number)
+- `scope_id` (Number)
+- `scope_type` (String)
+- `site_id` (Number)
+- `sitegroup_id` (Number)
+- `slug` (String)
+- `tag_ids` (List of Number)

netbox/data_source_netbox_vlan_group.go

@@ -14,27 +14,33 @@ func dataSourceNetboxVlanGroup() *schema.Resource {
 		Read:        dataSourceNetboxVlanGroupRead,
 		Description: `:meta:subcategory:IP Address Management (IPAM):`,
 		Schema: map[string]*schema.Schema{
+			"id": {
+				Type:     		schema.TypeString,
+				Computed: 		true,
+				Optional: 		true,
+				AtLeastOneOf: []string{"id", "name", "slug", "scope_type"},
+			},
 			"name": {
 				Type:         schema.TypeString,
 				Computed:     true,
 				Optional:     true,
-				AtLeastOneOf: []string{"name", "slug", "scope_type"},
+				AtLeastOneOf: []string{"id", "name", "slug", "scope_type"},
 			},
 			"slug": {
 				Type:         schema.TypeString,
 				Optional:     true,
 				Computed:     true,
-				AtLeastOneOf: []string{"name", "slug", "scope_type"},
+				AtLeastOneOf: []string{"id", "name", "slug", "scope_type"},
 			},
 			"scope_type": {
 				Type:         schema.TypeString,
 				Optional:     true,
 				ValidateFunc: validation.StringInSlice(resourceNetboxVlanGroupScopeTypeOptions, false),
 				Description:  buildValidValueDescription(resourceNetboxVlanGroupScopeTypeOptions),
-				AtLeastOneOf: []string{"name", "slug", "scope_type"},
+				AtLeastOneOf: []string{"id", "name", "slug", "scope_type"},
 			},
 			"scope_id": {
-				Type:         schema.TypeInt,
+				Type:         schema.TypeString,
 				Optional:     true,
 				RequiredWith: []string{"scope_type"},
 			},
@@ -55,17 +61,21 @@ func dataSourceNetboxVlanGroupRead(d *schema.ResourceData, m interface{}) error
 	params := ipam.NewIpamVlanGroupsListParams()
 
 	params.Limit = int64ToPtr(2)
+	
+	if id, ok := d.Get("id").(string); ok && id != "" {
+		params.ID = strToPtr(id)
+	}
 	if name, ok := d.Get("name").(string); ok && name != "" {
-		params.Name = &name
+		params.Name = strToPtr(name)
 	}
 	if slug, ok := d.Get("slug").(string); ok && slug != "" {
-		params.Slug = &slug
+		params.Slug = strToPtr(slug)
 	}
 	if scopeType, ok := d.Get("scope_type").(string); ok && scopeType != "" {
-		params.SetScopeType(&scopeType)
+		params.ScopeType = strToPtr(scopeType)
 	}
 	if scopeID, ok := d.Get("scope_id").(string); ok && scopeID != "" {
-		params.SetScopeID(params.ScopeID)
+		params.ScopeID = strToPtr(scopeID)
 	}
 
 	res, err := api.Ipam.IpamVlanGroupsList(params, nil)
@@ -82,9 +92,14 @@ func dataSourceNetboxVlanGroupRead(d *schema.ResourceData, m interface{}) error
 
 	result := res.GetPayload().Results[0]
 	d.SetId(strconv.FormatInt(result.ID, 10))
+	d.Set("id", result.ID)
 	d.Set("name", result.Name)
 	d.Set("slug", result.Slug)
 	d.Set("vlan_count", result.VlanCount)
 	d.Set("description", result.Description)
+	if result.ScopeID != nil {
+		d.Set("scope_id", result.ScopeID)
+	}
+	d.Set("scope_type", result.ScopeType)
 	return nil
 }

netbox/data_source_netbox_vlan_group_test.go

@@ -24,6 +24,12 @@ func TestAccNetboxVlanGroupDataSource_basic(t *testing.T) {
 				Config:      setUp + testAccNetboxVlanGroupDataNoResult,
 				ExpectError: regexp.MustCompile("no vlan group found matching filter"),
 			},
+			{
+				Config: setUp + testAccNetboxVlanGroupDataByID("netbox_vlan_group.test", "id"),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttrPair("data.netbox_vlan_group.test", "id", "netbox_vlan_group.test", "id"),
+				),
+			},
 			{
 				Config: setUp + testAccNetboxVlanGroupDataByName(testName),
 				Check: resource.ComposeTestCheckFunc(
@@ -109,6 +115,13 @@ data "netbox_vlan_group" "no_result" {
   name = "_no_result_"
 }`
 
+func testAccNetboxVlanGroupDataByID(resourceRef, field string) string {
+	return fmt.Sprintf(`
+data "netbox_vlan_group" "test" {
+  id = %[1]s.%[2]s
+}`, resourceRef, field)
+}
+
 func testAccNetboxVlanGroupDataByName(testName string) string {
 	return fmt.Sprintf(`
 data "netbox_vlan_group" "test" {