network

Documentation

Overview

Package network regroups collecting information about the network interfaces

Index

• type Network
  • func Get() (*Network, []string, error)
  • func (network *Network) Collect() (result interface{}, err error)
  • func (network *Network) Name() string

Types

type Network

type Network struct {
	// IpAddress is the ipv4 address for the host
	IpAddress string
	// IpAddressv6 is the ipv6 address for the host
	IpAddressv6 string
	// MacAddress is the macaddress for the host
	MacAddress string
}

Network holds network metadata about the host

func Get

func Get() (*Network, []string, error)

Get returns a Network struct already initialized, a list of warnings and an error. The method will try to collect as much metadata as possible, an error is returned if nothing could be collected. The list of warnings contains errors if some metadata could not be collected.

func (*Network) Collect

func (network *Network) Collect() (result interface{}, err error)

Collect collects the Network information. Returns an object which can be converted to a JSON or an error if nothing could be collected. Tries to collect as much information as possible.

func (*Network) Name

func (network *Network) Name() string

Name returns the name of the package