nethelpers

package
v1.2.9 Latest Latest
Warning

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

 Go to latest Published: Mar 10, 2023 License: MPL-2.0 Imports: 12 Imported by: 0

Documentation

Overview

Package nethelpers provides types and type wrappers to support network resources.

Index

Constants

View Source 
const RouteFlagsMask = RouteNotify | RouteCloned | RouteEqualize | RoutePrefix

RouteFlagsMask is a supported set of flags to manage.

Variables

This section is empty.

Functions

func JoinHostPort added in v1.2.0 

func JoinHostPort[T ints](host string, port T) string

JoinHostPort is a wrapper around net.JoinHostPort which accepts port any integer type.

func MapNetAddrToStd added in v1.2.0 

func MapNetAddrToStd(in []netaddr.IP) []net.IP

MapNetAddrToStd converts a slice of netaddr.Addr to a slice of net.IP.

func MapStdToNetAddr added in v1.2.0 

func MapStdToNetAddr(in []net.IP) []netaddr.IP

MapStdToNetAddr converts a slice of net.IP to a slice of netaddr.Addr.

Types

type ADSelect 

type ADSelect uint8

ADSelect is ADSelect. 

const (
	ADSelectStable    ADSelect = iota // stable
	ADSelectBandwidth                 // bandwidth
	ADSelectCount                     // count
)

ADSelect constants.

func ADSelectByName 

func ADSelectByName(sel string) (ADSelect, error)

ADSelectByName parses ADSelect.

func ADSelectString added in v1.0.0 

func ADSelectString(s string) (ADSelect, error)

ADSelectString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func ADSelectValues added in v1.0.0 

func ADSelectValues() []ADSelect

ADSelectValues returns all values of the enum

func (ADSelect) IsAADSelect added in v1.0.0 

func (i ADSelect) IsAADSelect() bool

IsAADSelect returns "true" if the value is listed in the enum definition. "false" otherwise

func (ADSelect) MarshalText added in v1.0.0 

func (i ADSelect) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface for ADSelect

func (ADSelect) String 

func (i ADSelect) String() string

func (*ADSelect) UnmarshalText added in v1.0.0 

func (i *ADSelect) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface for ADSelect

type ARPAllTargets 

type ARPAllTargets uint32

ARPAllTargets is an ARP targets mode. 

const (
	ARPAllTargetsAny ARPAllTargets = iota // any
	ARPAllTargetsAll                      // all
)

ARPAllTargets contants.

func ARPAllTargetsByName 

func ARPAllTargetsByName(a string) (ARPAllTargets, error)

ARPAllTargetsByName parses ARPAllTargets.

func ARPAllTargetsString added in v1.0.0 

func ARPAllTargetsString(s string) (ARPAllTargets, error)

ARPAllTargetsString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func ARPAllTargetsValues added in v1.0.0 

func ARPAllTargetsValues() []ARPAllTargets

ARPAllTargetsValues returns all values of the enum

func (ARPAllTargets) IsAARPAllTargets added in v1.0.0 

func (i ARPAllTargets) IsAARPAllTargets() bool

IsAARPAllTargets returns "true" if the value is listed in the enum definition. "false" otherwise

func (ARPAllTargets) MarshalText added in v1.0.0 

func (i ARPAllTargets) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface for ARPAllTargets

func (ARPAllTargets) String 

func (i ARPAllTargets) String() string

func (*ARPAllTargets) UnmarshalText added in v1.0.0 

func (i *ARPAllTargets) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface for ARPAllTargets

type ARPValidate 

type ARPValidate uint32

ARPValidate is an ARP Validation mode. 

const (
	ARPValidateNone   ARPValidate = iota // none
	ARPValidateActive                    // active
	ARPValidateBackup                    // backup
	ARPValidateAll                       // all
)

ARPValidate constants.

func ARPValidateByName 

func ARPValidateByName(a string) (ARPValidate, error)

ARPValidateByName parses ARPValidate.

func ARPValidateString added in v1.0.0 

func ARPValidateString(s string) (ARPValidate, error)

ARPValidateString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func ARPValidateValues added in v1.0.0 

func ARPValidateValues() []ARPValidate

ARPValidateValues returns all values of the enum

func (ARPValidate) IsAARPValidate added in v1.0.0 

func (i ARPValidate) IsAARPValidate() bool

IsAARPValidate returns "true" if the value is listed in the enum definition. "false" otherwise

func (ARPValidate) MarshalText added in v1.0.0 

func (i ARPValidate) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface for ARPValidate

func (ARPValidate) String 

func (i ARPValidate) String() string

func (*ARPValidate) UnmarshalText added in v1.0.0 

func (i *ARPValidate) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface for ARPValidate

type AddressFlag 

type AddressFlag uint32

AddressFlag wraps IFF_* constants. 

const (
	AddressTemporary      AddressFlag = 1 << iota // temporary
	AddressNoDAD                                  // nodad
	AddressOptimistic                             // optimistic
	AddressDADFailed                              // dadfailed
	AddressHome                                   // homeaddress
	AddressDeprecated                             // deprecated
	AddressTentative                              // tentative
	AddressPermanent                              // permanent
	AddressManagementTemp                         // mngmtmpaddr
	AddressNoPrefixRoute                          // noprefixroute
	AddressMCAutoJoin                             // mcautojoin
	AddressStablePrivacy                          // stableprivacy
)

AddressFlag constants.

func AddressFlagString added in v1.0.0 

func AddressFlagString(s string) (AddressFlag, error)

AddressFlagString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func AddressFlagValues added in v1.0.0 

func AddressFlagValues() []AddressFlag

AddressFlagValues returns all values of the enum

func (AddressFlag) IsAAddressFlag added in v1.0.0 

func (i AddressFlag) IsAAddressFlag() bool

IsAAddressFlag returns "true" if the value is listed in the enum definition. "false" otherwise

func (AddressFlag) MarshalText added in v1.0.0 

func (i AddressFlag) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface for AddressFlag

func (AddressFlag) String 

func (i AddressFlag) String() string

func (*AddressFlag) UnmarshalText added in v1.0.0 

func (i *AddressFlag) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface for AddressFlag

type AddressFlags 

type AddressFlags uint32

AddressFlags is a bitmask of AddressFlag.

func AddressFlagsString added in v1.0.0 

func AddressFlagsString(s string) (AddressFlags, error)

AddressFlagsString converts string representation of flags into AddressFlags.

func (AddressFlags) MarshalText added in v1.0.0 

func (flags AddressFlags) MarshalText() ([]byte, error)

MarshalText implements text.Marshaler.

func (AddressFlags) String 

func (flags AddressFlags) String() string

func (*AddressFlags) UnmarshalText added in v1.0.0 

func (flags *AddressFlags) UnmarshalText(b []byte) error

UnmarshalText implements text.Unmarshaler.

type BondMode 

type BondMode uint8

BondMode is a bond mode. 

const (
	BondModeRoundrobin   BondMode = iota // balance-rr
	BondModeActiveBackup                 // active-backup
	BondModeXOR                          // balance-xor
	BondModeBroadcast                    // broadcast
	BondMode8023AD                       // 802.3ad
	BondModeTLB                          // balance-tlb
	BondModeALB                          // balance-alb
)

BondMode constants.

See linux/if_bonding.h.

func BondModeByName 

func BondModeByName(mode string) (bm BondMode, err error)

BondModeByName converts string bond mode into a constant.

func BondModeString added in v1.0.0 

func BondModeString(s string) (BondMode, error)

BondModeString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func BondModeValues added in v1.0.0 

func BondModeValues() []BondMode

BondModeValues returns all values of the enum

func (BondMode) IsABondMode added in v1.0.0 

func (i BondMode) IsABondMode() bool

IsABondMode returns "true" if the value is listed in the enum definition. "false" otherwise

func (BondMode) MarshalText added in v1.0.0 

func (i BondMode) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface for BondMode

func (BondMode) String 

func (i BondMode) String() string

func (*BondMode) UnmarshalText added in v1.0.0 

func (i *BondMode) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface for BondMode

type BondXmitHashPolicy 

type BondXmitHashPolicy uint8

BondXmitHashPolicy is a bond hash policy. 

const (
	BondXmitPolicyLayer2  BondXmitHashPolicy = iota // layer2
	BondXmitPolicyLayer34                           // layer3+4
	BondXmitPolicyLayer23                           // layer2+3
	BondXmitPolicyEncap23                           // encap2+3
	BondXmitPolicyEncap34                           // encap3+4
)

Bond hash policy constants.

func BondXmitHashPolicyByName 

func BondXmitHashPolicyByName(policy string) (BondXmitHashPolicy, error)

BondXmitHashPolicyByName parses bond hash policy.

func BondXmitHashPolicyString added in v1.0.0 

func BondXmitHashPolicyString(s string) (BondXmitHashPolicy, error)

BondXmitHashPolicyString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func BondXmitHashPolicyValues added in v1.0.0 

func BondXmitHashPolicyValues() []BondXmitHashPolicy

BondXmitHashPolicyValues returns all values of the enum

func (BondXmitHashPolicy) IsABondXmitHashPolicy added in v1.0.0 

func (i BondXmitHashPolicy) IsABondXmitHashPolicy() bool

IsABondXmitHashPolicy returns "true" if the value is listed in the enum definition. "false" otherwise

func (BondXmitHashPolicy) MarshalText added in v1.0.0 

func (i BondXmitHashPolicy) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface for BondXmitHashPolicy

func (BondXmitHashPolicy) String 

func (i BondXmitHashPolicy) String() string

func (*BondXmitHashPolicy) UnmarshalText added in v1.0.0 

func (i *BondXmitHashPolicy) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface for BondXmitHashPolicy

type DeviceInfo added in v1.1.0 

type DeviceInfo struct {
	BusPath string
	PCIID   string
	Driver  string
}

DeviceInfo contains device hardware information that can be read from /sys/.

func GetDeviceInfo added in v1.1.0 

func GetDeviceInfo(deviceName string) (*DeviceInfo, error)

GetDeviceInfo get additional device information by reading /sys/ directory.

type Duplex 

type Duplex ethtool.Duplex

Duplex wraps ethtool.Duplex for YAML marshaling. 

const (
	Half    Duplex = Duplex(ethtool.Half)
	Full    Duplex = Duplex(ethtool.Full)
	Unknown Duplex = Duplex(ethtool.Unknown)
)

Possible Duplex type values.

func DuplexString added in v1.1.0 

func DuplexString(s string) (Duplex, error)

DuplexString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func DuplexValues added in v1.1.0 

func DuplexValues() []Duplex

DuplexValues returns all values of the enum

func (Duplex) IsADuplex added in v1.1.0 

func (i Duplex) IsADuplex() bool

IsADuplex returns "true" if the value is listed in the enum definition. "false" otherwise

func (Duplex) MarshalText added in v1.0.0 

func (i Duplex) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface for Duplex

func (Duplex) String added in v1.1.0 

func (i Duplex) String() string

func (*Duplex) UnmarshalText added in v1.1.0 

func (i *Duplex) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface for Duplex

type FailOverMAC 

type FailOverMAC uint8

FailOverMAC is a MAC failover mode. 

const (
	FailOverMACNone   FailOverMAC = iota // none
	FailOverMACActive                    // active
	FailOverMACFollow                    // follow
)

FailOverMAC constants.

func FailOverMACByName 

func FailOverMACByName(f string) (FailOverMAC, error)

FailOverMACByName parses FailOverMac.

func FailOverMACString added in v1.0.0 

func FailOverMACString(s string) (FailOverMAC, error)

FailOverMACString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func FailOverMACValues added in v1.0.0 

func FailOverMACValues() []FailOverMAC

FailOverMACValues returns all values of the enum

func (FailOverMAC) IsAFailOverMAC added in v1.0.0 

func (i FailOverMAC) IsAFailOverMAC() bool

IsAFailOverMAC returns "true" if the value is listed in the enum definition. "false" otherwise

func (FailOverMAC) String 

func (i FailOverMAC) String() string

type Family 

type Family uint8

Family is a network family. 

const (
	FamilyInet4 Family = 2  // inet4
	FamilyInet6 Family = 10 // inet6
)

Family constants.

func FamilyString added in v1.0.0 

func FamilyString(s string) (Family, error)

FamilyString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func FamilyValues added in v1.0.0 

func FamilyValues() []Family

FamilyValues returns all values of the enum

func (Family) IsAFamily added in v1.0.0 

func (i Family) IsAFamily() bool

IsAFamily returns "true" if the value is listed in the enum definition. "false" otherwise

func (Family) MarshalText added in v1.0.0 

func (i Family) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface for Family

func (Family) String 

func (i Family) String() string

func (*Family) UnmarshalText added in v1.0.0 

func (i *Family) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface for Family

type HardwareAddr 

type HardwareAddr net.HardwareAddr

HardwareAddr wraps net.HardwareAddr for YAML marshaling.

func (HardwareAddr) MarshalText added in v1.0.0 

func (addr HardwareAddr) MarshalText() ([]byte, error)

MarshalText implements text.Marshaler interface.

func (HardwareAddr) String added in v0.13.0 

func (addr HardwareAddr) String() string

func (*HardwareAddr) UnmarshalText added in v1.1.0 

func (addr *HardwareAddr) UnmarshalText(b []byte) error

UnmarshalText implements text.Unmarshaler interface.

type LACPRate 

type LACPRate uint8

LACPRate is a LACP rate. 

const (
	LACPRateSlow LACPRate = iota // slow
	LACPRateFast                 // fast
)

LACP rate constants.

func LACPRateByName 

func LACPRateByName(mode string) (LACPRate, error)

LACPRateByName parses LACPRate.

func LACPRateString added in v1.0.0 

func LACPRateString(s string) (LACPRate, error)

LACPRateString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func LACPRateValues added in v1.0.0 

func LACPRateValues() []LACPRate

LACPRateValues returns all values of the enum

func (LACPRate) IsALACPRate added in v1.0.0 

func (i LACPRate) IsALACPRate() bool

IsALACPRate returns "true" if the value is listed in the enum definition. "false" otherwise

func (LACPRate) MarshalText added in v1.0.0 

func (i LACPRate) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface for LACPRate

func (LACPRate) String 

func (i LACPRate) String() string

func (*LACPRate) UnmarshalText added in v1.0.0 

func (i *LACPRate) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface for LACPRate

type LinkFlag 

type LinkFlag uint32

LinkFlag wraps IFF_* constants. 

const (
	LinkUp           LinkFlag = 1 << iota // UP
	LinkBroadcast                         // BROADCAST
	LinkDebug                             // DEBUG
	LinkLoopback                          // LOOPBACK
	LinkPointToPoint                      // POINTTOPOINT
	LinkNoTrailers                        // NOTRAILERS
	LinkRunning                           // RUNNING
	LinkNoArp                             // NOARP
	LinkPromisc                           // PROMISC
	LinkAllMulti                          // ALLMULTI
	LinkMaster                            // MASTER
	LinkSlave                             // SLAVE
	LinkMulticase                         // MULTICAST
	LinkPortsel                           // PORTSEL
	LinKAutoMedia                         // AUTOMEDIA
	LinkDynamic                           // DYNAMIC
	LinkLowerUp                           // LOWER_UP
	LinkDormant                           // DORMANT
	LinkEcho                              // ECHO
)

LinkFlag constants.

func LinkFlagString added in v1.0.0 

func LinkFlagString(s string) (LinkFlag, error)

LinkFlagString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func LinkFlagValues added in v1.0.0 

func LinkFlagValues() []LinkFlag

LinkFlagValues returns all values of the enum

func (LinkFlag) IsALinkFlag added in v1.0.0 

func (i LinkFlag) IsALinkFlag() bool

IsALinkFlag returns "true" if the value is listed in the enum definition. "false" otherwise

func (LinkFlag) MarshalText added in v1.0.0 

func (i LinkFlag) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface for LinkFlag

func (LinkFlag) String 

func (i LinkFlag) String() string

func (*LinkFlag) UnmarshalText added in v1.0.0 

func (i *LinkFlag) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface for LinkFlag

type LinkFlags 

type LinkFlags uint32

LinkFlags is a bitmask of LinkFlags.

func LinkFlagsString added in v1.0.0 

func LinkFlagsString(s string) (LinkFlags, error)

LinkFlagsString parses string representation of LinkFlags.

func (LinkFlags) MarshalText added in v1.0.0 

func (flags LinkFlags) MarshalText() ([]byte, error)

MarshalText implements text.Marshaler.

func (LinkFlags) String 

func (flags LinkFlags) String() string

func (*LinkFlags) UnmarshalText added in v1.0.0 

func (flags *LinkFlags) UnmarshalText(b []byte) error

UnmarshalText implements text.Unmarshaler.

type LinkType 

type LinkType uint16

LinkType is a link type. 

const (
	LinkNetrom            LinkType = 0                 // netrom
	LinkEther             LinkType = 1                 // ether
	LinkEether            LinkType = 2                 // eether
	LinkAx25              LinkType = 3                 // ax25
	LinkPronet            LinkType = 4                 // pronet
	LinkChaos             LinkType = 5                 // chaos
	LinkIee802            LinkType = 6                 // ieee802
	LinkArcnet            LinkType = 7                 // arcnet
	LinkAtalk             LinkType = 8                 // atalk
	LinkDlci              LinkType = 15                // dlci
	LinkAtm               LinkType = 19                // atm
	LinkMetricom          LinkType = 23                // metricom
	LinkIeee1394          LinkType = 24                // ieee1394
	LinkEui64             LinkType = 27                // eui64
	LinkInfiniband        LinkType = 32                // infiniband
	LinkSlip              LinkType = 256               // slip
	LinkCslip             LinkType = 257               // cslip
	LinkSlip6             LinkType = 258               // slip6
	LinkCslip6            LinkType = 259               // cslip6
	LinkRsrvd             LinkType = 260               // rsrvd
	LinkAdapt             LinkType = 264               // adapt
	LinkRose              LinkType = 270               // rose
	LinkX25               LinkType = 271               // x25
	LinkHwx25             LinkType = 272               // hwx25
	LinkCan               LinkType = 280               // can
	LinkPpp               LinkType = 512               // ppp
	LinkCisco             LinkType = 513               // cisco
	LinkHdlc              LinkType = 513               // hdlc
	LinkLapb              LinkType = 516               // lapb
	LinkDdcmp             LinkType = 517               // ddcmp
	LinkRawhdlc           LinkType = 518               // rawhdlc
	LinkTunnel            LinkType = 768               // ipip
	LinkTunnel6           LinkType = 769               // tunnel6
	LinkFrad              LinkType = 770               // frad
	LinkSkip              LinkType = 771               // skip
	LinkLoopbck           LinkType = 772               // loopback
	LinkLocaltlk          LinkType = 773               // localtlk
	LinkFddi              LinkType = 774               // fddi
	LinkBif               LinkType = 775               // bif
	LinkSit               LinkType = 776               // sit
	LinkIpddp             LinkType = 777               // ip/ddp
	LinkIpgre             LinkType = 778               // gre
	LinkPimreg            LinkType = 779               // pimreg
	LinkHippi             LinkType = 780               // hippi
	LinkAsh               LinkType = 781               // ash
	LinkEconet            LinkType = 782               // econet
	LinkIrda              LinkType = 783               // irda
	LinkFcpp              LinkType = 784               // fcpp
	LinkFcal              LinkType = 785               // fcal
	LinkFcpl              LinkType = 786               // fcpl
	LinkFcfabric          LinkType = 787               // fcfb_0
	LinkFcfabric1         LinkType = LinkFcfabric + 1  // fcfb_1
	LinkFcfabric2         LinkType = LinkFcfabric + 2  // fcfb_2
	LinkFcfabric3         LinkType = LinkFcfabric + 3  // fcfb_3
	LinkFcfabric4         LinkType = LinkFcfabric + 4  // fcfb_4
	LinkFcfabric5         LinkType = LinkFcfabric + 5  // fcfb_5
	LinkFcfabric6         LinkType = LinkFcfabric + 6  // fcfb_6
	LinkFcfabric7         LinkType = LinkFcfabric + 7  // fcfb_7
	LinkFcfabric8         LinkType = LinkFcfabric + 8  // fcfb_8
	LinkFcfabric9         LinkType = LinkFcfabric + 9  // fcfb_9
	LinkFcfabric10        LinkType = LinkFcfabric + 10 // fcfb_10
	LinkFcfabric11        LinkType = LinkFcfabric + 11 // fcfb_11
	LinkFcfabric12        LinkType = LinkFcfabric + 12 // fcfb_12
	LinkIee802tr          LinkType = 800               // tr
	LinkIee80211          LinkType = 801               // ieee802.11
	LinkIee80211prism     LinkType = 802               // ieee802.11_prism
	LinkIee80211Radiotap  LinkType = 803               // ieee802.11_radiotap
	LinkIee8021154        LinkType = 804               // ieee802.15.4
	LinkIee8021154monitor LinkType = 805               // ieee802.15.4_monitor
	LinkPhonet            LinkType = 820               // phonet
	LinkPhonetpipe        LinkType = 821               // phonet_pipe
	LinkCaif              LinkType = 822               // caif
	LinkIP6gre            LinkType = 823               // ip6gre
	LinkNetlink           LinkType = 824               // netlink
	Link6Lowpan           LinkType = 825               // 6lowpan
	LinkVoid              LinkType = 65535             // void
	LinkNone              LinkType = 65534             // nohdr
)

LinkType constants.

func LinkTypeString added in v1.0.0 

func LinkTypeString(s string) (LinkType, error)

LinkTypeString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func LinkTypeValues added in v1.0.0 

func LinkTypeValues() []LinkType

LinkTypeValues returns all values of the enum

func (LinkType) IsALinkType added in v1.0.0 

func (i LinkType) IsALinkType() bool

IsALinkType returns "true" if the value is listed in the enum definition. "false" otherwise

func (LinkType) MarshalText added in v1.0.0 

func (i LinkType) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface for LinkType

func (LinkType) String 

func (i LinkType) String() string

func (*LinkType) UnmarshalText added in v1.0.0 

func (i *LinkType) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface for LinkType

type OperationalState 

type OperationalState uint8

OperationalState wraps rtnetlink.OperationalState for YAML marshaling. 

const (
	OperStateUnknown        OperationalState = OperationalState(rtnetlink.OperStateUnknown)        // unknown
	OperStateNotPresent     OperationalState = OperationalState(rtnetlink.OperStateNotPresent)     // notPresent
	OperStateDown           OperationalState = OperationalState(rtnetlink.OperStateDown)           // down
	OperStateLowerLayerDown OperationalState = OperationalState(rtnetlink.OperStateLowerLayerDown) // lowerLayerDown
	OperStateTesting        OperationalState = OperationalState(rtnetlink.OperStateTesting)        // testing
	OperStateDormant        OperationalState = OperationalState(rtnetlink.OperStateDormant)        // dormant
	OperStateUp             OperationalState = OperationalState(rtnetlink.OperStateUp)             // up
)

Constants copied from rtnetlink to provide Stringer interface.

func OperationalStateString added in v1.0.0 

func OperationalStateString(s string) (OperationalState, error)

OperationalStateString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func OperationalStateValues added in v1.0.0 

func OperationalStateValues() []OperationalState

OperationalStateValues returns all values of the enum

func (OperationalState) IsAOperationalState added in v1.0.0 

func (i OperationalState) IsAOperationalState() bool

IsAOperationalState returns "true" if the value is listed in the enum definition. "false" otherwise

func (OperationalState) MarshalText added in v1.0.0 

func (i OperationalState) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface for OperationalState

func (OperationalState) String 

func (i OperationalState) String() string

func (*OperationalState) UnmarshalText added in v1.0.0 

func (i *OperationalState) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface for OperationalState

type Port 

type Port ethtool.Port

Port wraps ethtool.Port for YAML marshaling. 

const (
	TwistedPair  Port = Port(ethtool.TwistedPair)
	AUI          Port = Port(ethtool.AUI)
	MII          Port = Port(ethtool.MII)
	Fibre        Port = Port(ethtool.Fibre) //nolint:misspell
	BNC          Port = Port(ethtool.BNC)
	DirectAttach Port = Port(ethtool.DirectAttach)
	None         Port = Port(ethtool.None)
	Other        Port = Port(ethtool.Other)
)

Possible Port type values.

func PortString added in v1.1.0 

func PortString(s string) (Port, error)

PortString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func PortValues added in v1.1.0 

func PortValues() []Port

PortValues returns all values of the enum

func (Port) IsAPort added in v1.1.0 

func (i Port) IsAPort() bool

IsAPort returns "true" if the value is listed in the enum definition. "false" otherwise

func (Port) MarshalText added in v1.0.0 

func (i Port) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface for Port

func (Port) String added in v1.1.0 

func (i Port) String() string

func (*Port) UnmarshalText added in v1.1.0 

func (i *Port) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface for Port

type PrimaryReselect 

type PrimaryReselect uint8

PrimaryReselect is an ARP targets mode. 

const (
	PrimaryReselectAlways  PrimaryReselect = iota // always
	PrimaryReselectBetter                         // better
	PrimaryReselectFailure                        // failure
)

PrimaryReslect constants.

func PrimaryReselectByName 

func PrimaryReselectByName(p string) (PrimaryReselect, error)

PrimaryReselectByName parses PrimaryReselect.

func PrimaryReselectString added in v1.0.0 

func PrimaryReselectString(s string) (PrimaryReselect, error)

PrimaryReselectString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func PrimaryReselectValues added in v1.0.0 

func PrimaryReselectValues() []PrimaryReselect

PrimaryReselectValues returns all values of the enum

func (PrimaryReselect) IsAPrimaryReselect added in v1.0.0 

func (i PrimaryReselect) IsAPrimaryReselect() bool

IsAPrimaryReselect returns "true" if the value is listed in the enum definition. "false" otherwise

func (PrimaryReselect) MarshalText added in v1.0.0 

func (i PrimaryReselect) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface for PrimaryReselect

func (PrimaryReselect) String 

func (i PrimaryReselect) String() string

func (*PrimaryReselect) UnmarshalText added in v1.0.0 

func (i *PrimaryReselect) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface for PrimaryReselect

type RouteFlag 

type RouteFlag uint32

RouteFlag wraps RTM_F_* constants. 

const (
	RouteNotify      RouteFlag = 256 << iota // notify
	RouteCloned                              // cloned
	RouteEqualize                            // equalize
	RoutePrefix                              // prefix
	RouteLookupTable                         // lookup_table
	RouteFIBMatch                            // fib_match
	RouteOffload                             // offload
	RouteTrap                                // trap
)

RouteFlag constants.

func RouteFlagString added in v1.0.0 

func RouteFlagString(s string) (RouteFlag, error)

RouteFlagString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func RouteFlagValues added in v1.0.0 

func RouteFlagValues() []RouteFlag

RouteFlagValues returns all values of the enum

func (RouteFlag) IsARouteFlag added in v1.0.0 

func (i RouteFlag) IsARouteFlag() bool

IsARouteFlag returns "true" if the value is listed in the enum definition. "false" otherwise

func (RouteFlag) MarshalText added in v1.0.0 

func (i RouteFlag) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface for RouteFlag

func (RouteFlag) String 

func (i RouteFlag) String() string

func (*RouteFlag) UnmarshalText added in v1.0.0 

func (i *RouteFlag) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface for RouteFlag

type RouteFlags 

type RouteFlags uint32

RouteFlags is a bitmask of RouteFlag.

func RouteFlagsString added in v1.0.0 

func RouteFlagsString(s string) (RouteFlags, error)

RouteFlagsString parses string representation into RouteFlags.

func (RouteFlags) Equal 

func (flags RouteFlags) Equal(other RouteFlags) bool

Equal tests for RouteFlags equality ignoring flags not managed by this implementation.

func (RouteFlags) MarshalText added in v1.0.0 

func (flags RouteFlags) MarshalText() ([]byte, error)

MarshalText implements text.Marshaler.

func (RouteFlags) String 

func (flags RouteFlags) String() string

func (*RouteFlags) UnmarshalText added in v1.0.0 

func (flags *RouteFlags) UnmarshalText(b []byte) error

UnmarshalText implements text.Unmarshaler.

type RouteProtocol 

type RouteProtocol uint8

RouteProtocol is a routing protocol. 

const (
	ProtocolUnspec     RouteProtocol = 0   // unspec
	ProtocolRedirect   RouteProtocol = 1   // redirect
	ProtocolKernel     RouteProtocol = 2   // kernel
	ProtocolBoot       RouteProtocol = 3   // boot
	ProtocolStatic     RouteProtocol = 4   // static
	ProtocolRA         RouteProtocol = 9   // ra
	ProtocolMRT        RouteProtocol = 10  // mrt
	ProtocolZebra      RouteProtocol = 11  // zebra
	ProtocolBird       RouteProtocol = 12  // bird
	ProtocolDnrouted   RouteProtocol = 13  // dnrouted
	ProtocolXorp       RouteProtocol = 14  // xorp
	ProtocolNTK        RouteProtocol = 15  // ntk
	ProtocolDHCP       RouteProtocol = 16  // dhcp
	ProtocolMRTD       RouteProtocol = 17  // mrtd
	ProtocolKeepalived RouteProtocol = 18  // keepalived
	ProtocolBabel      RouteProtocol = 42  // babel
	ProtocolOpenr      RouteProtocol = 99  // openr
	ProtocolBGP        RouteProtocol = 186 // bgp
	ProtocolISIS       RouteProtocol = 187 // isis
	ProtocolOSPF       RouteProtocol = 188 // ospf
	ProtocolRIP        RouteProtocol = 189 // rip
	ProtocolEIGRP      RouteProtocol = 192 // eigrp
)

RouteType constants.

func RouteProtocolString added in v1.0.0 

func RouteProtocolString(s string) (RouteProtocol, error)

RouteProtocolString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func RouteProtocolValues added in v1.0.0 

func RouteProtocolValues() []RouteProtocol

RouteProtocolValues returns all values of the enum

func (RouteProtocol) IsARouteProtocol added in v1.0.0 

func (i RouteProtocol) IsARouteProtocol() bool

IsARouteProtocol returns "true" if the value is listed in the enum definition. "false" otherwise

func (RouteProtocol) MarshalText added in v1.0.0 

func (i RouteProtocol) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface for RouteProtocol

func (RouteProtocol) String 

func (i RouteProtocol) String() string

func (*RouteProtocol) UnmarshalText added in v1.0.0 

func (i *RouteProtocol) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface for RouteProtocol

type RouteType 

type RouteType uint8

RouteType is a route type. 

const (
	TypeUnspec      RouteType = iota // unspec
	TypeUnicast                      // unicast
	TypeLocal                        // local
	TypeBroadcast                    // broadcast
	TypeAnycast                      // anycast
	TypeMulticast                    // multicast
	TypeBlackhole                    // blackhole
	TypeUnreachable                  // unreachable
	TypeProhibit                     // prohibit
	TypeThrow                        // throw
	TypeNAT                          // nat
	TypeXResolve                     // xresolve
)

RouteType constants.

func RouteTypeString added in v1.0.0 

func RouteTypeString(s string) (RouteType, error)

RouteTypeString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func RouteTypeValues added in v1.0.0 

func RouteTypeValues() []RouteType

RouteTypeValues returns all values of the enum

func (RouteType) IsARouteType added in v1.0.0 

func (i RouteType) IsARouteType() bool

IsARouteType returns "true" if the value is listed in the enum definition. "false" otherwise

func (RouteType) MarshalText added in v1.0.0 

func (i RouteType) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface for RouteType

func (RouteType) String 

func (i RouteType) String() string

func (*RouteType) UnmarshalText added in v1.0.0 

func (i *RouteType) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface for RouteType

type RoutingTable 

type RoutingTable uint32

RoutingTable is a routing table ID. 

const (
	TableUnspec  RoutingTable = 0   // unspec
	TableDefault RoutingTable = 253 // default
	TableMain    RoutingTable = 254 // main
	TableLocal   RoutingTable = 255 // local
)

RoutingTable constants.

func RoutingTableString added in v1.0.0 

func RoutingTableString(s string) (RoutingTable, error)

RoutingTableString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func RoutingTableValues added in v1.0.0 

func RoutingTableValues() []RoutingTable

RoutingTableValues returns all values of the enum

func (RoutingTable) IsARoutingTable added in v1.0.0 

func (i RoutingTable) IsARoutingTable() bool

IsARoutingTable returns "true" if the value is listed in the enum definition. "false" otherwise

func (RoutingTable) MarshalText added in v1.0.0 

func (i RoutingTable) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface for RoutingTable

func (RoutingTable) String 

func (i RoutingTable) String() string

func (*RoutingTable) UnmarshalText added in v1.0.0 

func (i *RoutingTable) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface for RoutingTable

type Scope 

type Scope uint8

Scope is an address scope. 

const (
	ScopeGlobal  Scope = 0   // global
	ScopeSite    Scope = 200 // site
	ScopeLink    Scope = 253 // link
	ScopeHost    Scope = 254 // host
	ScopeNowhere Scope = 255 // nowhere
)

Scope constants.

func ScopeString added in v1.0.0 

func ScopeString(s string) (Scope, error)

ScopeString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func ScopeValues added in v1.0.0 

func ScopeValues() []Scope

ScopeValues returns all values of the enum

func (Scope) IsAScope added in v1.0.0 

func (i Scope) IsAScope() bool

IsAScope returns "true" if the value is listed in the enum definition. "false" otherwise

func (Scope) MarshalText added in v1.0.0 

func (i Scope) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface for Scope

func (Scope) String 

func (i Scope) String() string

func (*Scope) UnmarshalText added in v1.0.0 

func (i *Scope) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface for Scope

type Status added in v1.0.0 

type Status int

Status is a network status.

Please see resources/network/status.go. 

const (
	StatusAddresses    Status = 1 // addresses
	StatusConnectivity Status = 2 // connectivity
	StatusHostname     Status = 3 // hostname
	StatusEtcFiles     Status = 4 // etcfiles
)

Status constants.

func StatusString added in v1.0.0 

func StatusString(s string) (Status, error)

StatusString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func StatusValues added in v1.0.0 

func StatusValues() []Status

StatusValues returns all values of the enum

func (Status) IsAStatus added in v1.0.0 

func (i Status) IsAStatus() bool

IsAStatus returns "true" if the value is listed in the enum definition. "false" otherwise

func (Status) MarshalText added in v1.0.0 

func (i Status) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface for Status

func (Status) String added in v1.0.0 

func (i Status) String() string

func (*Status) UnmarshalText added in v1.0.0 

func (i *Status) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface for Status

type VLANProtocol 

type VLANProtocol uint16

VLANProtocol is a VLAN protocol. 

const (
	VLANProtocol8021Q  VLANProtocol = 33024 // 802.1q
	VLANProtocol8021AD VLANProtocol = 34984 // 802.1ad
)

VLANProtocol constants.

func VLANProtocolString added in v1.0.0 

func VLANProtocolString(s string) (VLANProtocol, error)

VLANProtocolString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func VLANProtocolValues added in v1.0.0 

func VLANProtocolValues() []VLANProtocol

VLANProtocolValues returns all values of the enum

func (VLANProtocol) IsAVLANProtocol added in v1.0.0 

func (i VLANProtocol) IsAVLANProtocol() bool

IsAVLANProtocol returns "true" if the value is listed in the enum definition. "false" otherwise

func (VLANProtocol) MarshalText added in v1.0.0 

func (i VLANProtocol) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface for VLANProtocol

func (VLANProtocol) String 

func (i VLANProtocol) String() string

func (*VLANProtocol) UnmarshalText added in v1.0.0 

func (i *VLANProtocol) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface for VLANProtocol

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.