Skip to content

Commit

Permalink
feat: Add data IPAM service
Browse files Browse the repository at this point in the history
  • Loading branch information
smutel committed Feb 10, 2021
1 parent e167ef6 commit 69ae53c
Show file tree
Hide file tree
Showing 5 changed files with 129 additions and 6 deletions.
28 changes: 28 additions & 0 deletions docs/data-sources/ipam_service.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# netbox\_ipam\_service Data Source

Get info about ipam service from netbox.

## Example Usage

```hcl
data "netbox_ipam_service" "service_test" {
device_id = 5
name = "Mail"
port = 25
protocol = "tcp"
}
```

## Argument Reference

The following arguments are supported:
* ``device_id`` - (Optional) The ID of the device linked to this object.
* ``name`` - (Required) The name of this object.
* ``port`` - (Required) The port of this object.
* ``protocol`` - (Required) The protocol of this service (tcp or udp).
* ``virtualmachine_id`` - (Optional) The ID of the vm linked to this object.

## Attributes Reference

In addition to the above arguments, the following attributes are exported:
* ``id`` - The id (ref in Netbox) of this object.
10 changes: 10 additions & 0 deletions examples/.terraform.lock.hcl

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

85 changes: 85 additions & 0 deletions netbox/data_netbox_ipam_service.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
package netbox

import (
"fmt"
"strconv"

"github.com/hashicorp/terraform-plugin-sdk/helper/schema"
"github.com/hashicorp/terraform-plugin-sdk/helper/validation"
netboxclient "github.com/netbox-community/go-netbox/netbox/client"
"github.com/netbox-community/go-netbox/netbox/client/ipam"
)

func dataNetboxIpamService() *schema.Resource {
return &schema.Resource{
Read: dataNetboxIpamServiceRead,

Schema: map[string]*schema.Schema{
"device_id": {
Type: schema.TypeInt,
Optional: true,
ConflictsWith: []string{"virtualmachine_id"},
},
"name": {
Type: schema.TypeString,
Required: true,
ValidateFunc: validation.StringLenBetween(1, 50),
},
"port": {
Type: schema.TypeInt,
Required: true,
ValidateFunc: validation.IntBetween(1, 65535),
},
"protocol": {
Type: schema.TypeString,
Required: true,
ValidateFunc: validation.StringInSlice([]string{"tcp", "udp"}, false),
},
"virtualmachine_id": {
Type: schema.TypeInt,
Optional: true,
ConflictsWith: []string{"device_id"},
},
},
}
}

func dataNetboxIpamServiceRead(d *schema.ResourceData,
m interface{}) error {
client := m.(*netboxclient.NetBoxAPI)

deviceID := int64(d.Get("device_id").(int))
deviceIDStr := strconv.FormatInt(deviceID, 10)
name := d.Get("name").(string)
port := int64(d.Get("port").(int))
portStr := strconv.FormatInt(port, 10)
protocol := d.Get("protocol").(string)
vmID := int64(d.Get("virtualmachine_id").(int))
vmIDStr := strconv.FormatInt(vmID, 10)

p := ipam.NewIpamServicesListParams().WithName(&name)
p.SetPort(&portStr)
p.SetProtocol(&protocol)
if deviceID != 0 {
p.SetDeviceID(&deviceIDStr)
} else if vmID != 0 {
p.SetVirtualMachineID(&vmIDStr)
}

list, err := client.Ipam.IpamServicesList(p, nil)
if err != nil {
return err
}

if *list.Payload.Count < 1 {
return fmt.Errorf("Your query returned no results. " +
"Please change your search criteria and try again.")
} else if *list.Payload.Count > 1 {
return fmt.Errorf("Your query returned more than one result. " +
"Please try a more specific search criteria.")
}

d.SetId(strconv.FormatInt(list.Payload.Results[0].ID, 10))

return nil
}
1 change: 1 addition & 0 deletions netbox/provider.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ func Provider() *schema.Provider {
"netbox_ipam_aggregate": dataNetboxIpamAggregate(),
"netbox_ipam_ip_addresses": dataNetboxIpamIPAddresses(),
"netbox_ipam_role": dataNetboxIpamRole(),
"netbox_ipam_service": dataNetboxIpamService(),
"netbox_ipam_vlan": dataNetboxIpamVlan(),
"netbox_ipam_vlan_group": dataNetboxIpamVlanGroup(),
"netbox_json_circuits_circuit_terminations_list": dataNetboxJSONCircuitsCircuitTerminationsList(),
Expand Down
11 changes: 5 additions & 6 deletions netbox/resource_netbox_ipam_service.go
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,9 @@ func resourceNetboxIpamService() *schema.Resource {
ValidateFunc: validation.StringLenBetween(1, 200),
},
"device_id": {
Type: schema.TypeInt,
Optional: true,
ConflictsWith: []string{"virtualmachine_id"},
Type: schema.TypeInt,
Optional: true,
ExactlyOneOf: []string{"device_id", "virtualmachine_id"},
},
"ip_addresses_id": {
Type: schema.TypeList,
Expand Down Expand Up @@ -88,9 +88,8 @@ func resourceNetboxIpamService() *schema.Resource {
},
},
"virtualmachine_id": {
Type: schema.TypeInt,
Optional: true,
ConflictsWith: []string{"device_id"},
Type: schema.TypeInt,
Optional: true,
},
},
}
Expand Down

0 comments on commit 69ae53c

Please sign in to comment.