wireserver

Documentation

Index

• Variables
• type Address
• type Client
  • func (c *Client) GetInterfaces(ctx context.Context) (*GetInterfacesResult, error)
• type GetInterfacesResult
• type GetNetworkContainerOpts
• type Interface
• type InterfaceInfo
  • func GetPrimaryInterfaceFromResult(res *GetInterfacesResult) (*InterfaceInfo, error)
• type Subnet

Variables

var (
	// ErrNoPrimaryInterface indicates the wireserver respnose does not have a primary interface indicated.
	ErrNoPrimaryInterface = errors.New("no primary interface found")
	// ErrInsufficientAddressSpace indicates that the CIDR space is too small to include a gateway IP; it is 1 IP.
	ErrInsufficientAddressSpace = errors.New("insufficient address space to generate gateway IP")
)

Types

type Address

type Address struct {
	Address   string `xml:"Address,attr"`
	IsPrimary bool   `xml:"IsPrimary,attr"`
}

type Client

type Client struct {
	HTTPClient do
}

func (*Client) GetInterfaces

func (c *Client) GetInterfaces(ctx context.Context) (*GetInterfacesResult, error)

GetInterfaces queries interfaces from the wireserver.

type GetInterfacesResult

type GetInterfacesResult struct {
	Interface []Interface
}

GetInterfacesResult is the xml mapped response of the getInterfacesQuery

type GetNetworkContainerOpts

type GetNetworkContainerOpts struct {
	NetworkContainerID string
	PrimaryAddress     string
	AuthToken          string
	APIVersion         string
}

type Interface

type Interface struct {
	MacAddress string `xml:"MacAddress,attr"`
	IsPrimary  bool   `xml:"IsPrimary,attr"`
	IPSubnet   []Subnet
}

type InterfaceInfo

type InterfaceInfo struct {
	Subnet       string
	Gateway      string
	IsPrimary    bool
	PrimaryIP    string
	SecondaryIPs []string
}

InterfaceInfo specifies the information about an interface as returned by Host Agent.

func GetPrimaryInterfaceFromResult

func GetPrimaryInterfaceFromResult(res *GetInterfacesResult) (*InterfaceInfo, error)

type Subnet

type Subnet struct {
	Prefix    string `xml:"Prefix,attr"`
	IPAddress []Address
}