ipam

package
v2.9.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 3, 2024 License: Apache-2.0 Imports: 0 Imported by: 0

Documentation

Overview

Package ipam contains definitions for networks, addresses, etc.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddrStatus

type AddrStatus string

AddrStatus is the status of an address.

const (
	StatusPlanned  AddrStatus = "planned"
	StatusAssigned AddrStatus = "assigned"
)

A list of valid address statuses. The default status is StatusPlanned.

type Address

type Address struct {
	ID            int                    `json:"id"`
	Desc          string                 `json:"desc,omitempty"`
	Prefix        string                 `json:"prefix"`
	Name          string                 `json:"name,omitempty"`
	Network       int                    `json:"network_id,omitempty"`
	Status        AddrStatus             `json:"status,omitempty"`
	InheritedTags string                 `json:"inherited_tags,omitempty"`
	Total         string                 `json:"total_addresses"`
	Children      int                    `json:"children"`
	Free          string                 `json:"free_addresses"`
	Used          string                 `json:"used_addresses"`
	KVPS          map[string]interface{} `json:"kvps,omitempty"`
	Tags          map[string]interface{} `json:"tags"`
	DHCPScoped    bool                   `json:"dhcp_scoped"`
	Parent        int                    `json:"parent_id"`
}

Address wraps an NS1 /ipam/address resource.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL