subnets

Documentation

Overview

Package subnets provides types and methods for working with the subnets controller.

Index

• type Controller
  • func NewController(sess *session.Session) *Controller
  • func (c *Controller) CreateSubnet(in Subnet) (message string, err error)
  • func (c *Controller) DeleteSubnet(id int) (message string, err error)
  • func (c *Controller) GetAddressesInSubnet(id int) (out []addresses.Address, err error)
  • func (c *Controller) GetFirstFreeAddress(id int) (out string, err error)
  • func (c *Controller) GetSubnetByID(id int) (out Subnet, err error)
  • func (c *Controller) GetSubnetCustomFields(id int) (out map[string]interface{}, err error)
  • func (c *Controller) GetSubnetCustomFieldsSchema() (out map[string]phpipam.CustomField, err error)
  • func (c *Controller) GetSubnetsByCIDR(cidr string) (out []Subnet, err error)
  • func (c *Controller) UpdateSubnet(in Subnet) (message string, err error)
  • func (c *Controller) UpdateSubnetCustomFields(id int, in map[string]interface{}) (message string, err error)
• type Subnet

Types

type Controller

type Controller struct {
	client.Client
}

Controller is the base client for the Subnets controller.

func NewController

func NewController(sess *session.Session) *Controller

NewController returns a new instance of the client for the Subnets controller.

func (*Controller) CreateSubnet

func (c *Controller) CreateSubnet(in Subnet) (message string, err error)

CreateSubnet creates a subnet by sending a POST request.

func (*Controller) DeleteSubnet

func (c *Controller) DeleteSubnet(id int) (message string, err error)

DeleteSubnet deletes a subnet by its ID.

func (*Controller) GetAddressesInSubnet

func (c *Controller) GetAddressesInSubnet(id int) (out []addresses.Address, err error)

GetAddressesInSubnet GETs the IP addresses for a specific subnet, via a supplied subnet ID.

func (*Controller) GetFirstFreeAddress

func (c *Controller) GetFirstFreeAddress(id int) (out string, err error)

GetFirstFreeAddress GETs the first free IP address in a subnet and returns it as a string. This can be used to automatically determine the next address you should use. If there are no more available addresses, the string will be blank.

Note that marking a subnet as used does not prevent this function from returning data.

func (*Controller) GetSubnetByID

func (c *Controller) GetSubnetByID(id int) (out Subnet, err error)

GetSubnetByID GETs a subnet via its ID.

func (*Controller) GetSubnetCustomFields

func (c *Controller) GetSubnetCustomFields(id int) (out map[string]interface{}, err error)

GetSubnetCustomFields GETs the custom fields for a subnet via client.GetCustomFields.

func (*Controller) GetSubnetCustomFieldsSchema

func (c *Controller) GetSubnetCustomFieldsSchema() (out map[string]phpipam.CustomField, err error)

GetSubnetCustomFieldsSchema GETs the custom fields for the subnets controller via client.GetCustomFieldsSchema.

func (*Controller) GetSubnetsByCIDR

func (c *Controller) GetSubnetsByCIDR(cidr string) (out []Subnet, err error)

GetSubnetsByCIDR GETs a subnet via its CIDR (i.e. 10.10.1.0/24).

The function's name reflects the fact that an array of subnets is returned through the API, although it remains unclear how to actually query this method in a way that would return multiple results. Using a broader CIDR will not return multiple results, and using the CIDR of a master subnet will return that subnet only.

func (*Controller) UpdateSubnet

func (c *Controller) UpdateSubnet(in Subnet) (message string, err error)

UpdateSubnet updates a subnet by sending a PATCH request.

Note you cannot use this function to update a subnet's CIDR - to split, grow, or renumber a subnet, you need to use other methods that are currently not implemented in this SDK. See the API spec for more details.

func (*Controller) UpdateSubnetCustomFields

func (c *Controller) UpdateSubnetCustomFields(id int, in map[string]interface{}) (message string, err error)

UpdateSubnetCustomFields PATCHes the subnet's custom fields via client.UpdateCustomFields.

type Subnet

type Subnet struct {
	// The subnet ID.
	ID int `json:"id,string,omitempty"`

	// The subnet address, in dotted quad format (i.e. A.B.C.D).
	SubnetAddress string `json:"subnet,omitempty"`

	// The subnet's mask in number of bits (i.e. 24).
	Mask phpipam.JSONIntString `json:"mask,omitempty"`

	// A detailed description of the subnet.
	Description string `json:"description,omitempty"`

	// The section ID to add the subnet to (required when adding).
	SectionID int `json:"sectionId,string,omitempty"`

	// The ID of a linked IPv6 subnet.
	LinkedSubnet int `json:"linked_subnet,string,omitempty"`

	// The ID of the VLAN that this subnet belongs to.
	VLANID int `json:"vlanId,string,omitempty"`

	// The ID of the VRF this subnet belongs to.
	VRFID int `json:"vrfId,string,omitempty"`

	// The parent subnet ID if this is a nested subnet.
	MasterSubnetID int `json:"masterSubnetId,string,omitempty"`

	// The ID of the nameserver to attache the subnet to.
	NameserverID int `json:"nameserverId,string,omitempty"`

	// true if the name should be displayed in listing instead of the subnet
	// address.
	ShowName phpipam.BoolIntString `json:"showName,omitempty"`

	// A JSON object, stringified, that represents the permissions for this
	// section.
	Permissions string `json:"permissions,omitempty"`

	// Controls if PTR records should be created for the subnet.
	DNSRecursive phpipam.BoolIntString `json:"DNSrecursive,omitempty"`

	// Controls if DNS hostname records are displayed.
	DNSRecords phpipam.BoolIntString `json:"DNSrecords,omitempty"`

	// Controls if IP requests are allowed for the subnet.
	AllowRequests phpipam.BoolIntString `json:"allowRequests,omitempty"`

	// The ID of the scan agent to use for the subnet.
	ScanAgent int `json:"scanAgent,string,omitempty"`

	// Controls if the subnet should be included in status checks.
	PingSubnet phpipam.BoolIntString `json:"pingSubnet,omitempty"`

	// Controls if new hosts should be discovered for new host scans.
	DiscoverSubnet phpipam.BoolIntString `json:"discoverSubnet,omitempty"`

	// Controls if we are adding a subnet or folder.
	IsFolder phpipam.BoolIntString `json:"isFolder,omitempty"`

	// Marks the subnet as used.
	IsFull phpipam.BoolIntString `json:"isFull,omitempty"`

	// The threshold of the subnet.
	Threshold int `json:"threshold,string,omitempty"`

	// The location index of the subnet.
	Location int `json:"location,string,omitempty"`

	// The date of the last edit to this resource.
	EditDate string `json:"editDate,omitempty"`

	// A map[string]interface{} of custom fields to set on the resource. Note
	// that this functionality requires PHPIPAM 1.3 or higher with the "Nest
	// custom fields" flag set on the specific API integration. If this is not
	// enabled, this map will be nil on GETs and POSTs and PATCHes with this
	// field set will fail. Use the explicit custom field functions instead.
	CustomFields map[string]interface{} `json:"custom_fields,omitempty"`
}

Subnet represents a PHPIPAM subnet.