sysctl

Documentation

Overview

Package sysctl allows to change kernel parameters at runtime.

Index

• func ApplySettings(sysSettings []Setting) error
• func Disable(name string) error
• func Enable(name string) error
• func GetProcfs() string
• func Read(name string) (string, error)
• func ReadInt(name string) (int64, error)
• func SetProcfs(path string)
• func Write(name string, val string) error
• func WriteInt(name string, val int64) error
• type ErrInvalidSysctlParameter
  • func (e ErrInvalidSysctlParameter) Error() string
• type Setting

Functions

func ApplySettings

func ApplySettings(sysSettings []Setting) error

ApplySettings applies all settings in sysSettings.

func Disable

func Disable(name string) error

Disable disables the given sysctl parameter.

func Enable

func Enable(name string) error

Enable enables the given sysctl parameter.

func GetProcfs

func GetProcfs() string

GetProcfs returns the path set in procFs. Executing SetProcFs after GetProcfs might panic depending. See SetProcfs for more info.

func Read

func Read(name string) (string, error)

Read reads the given sysctl parameter.

func ReadInt

func ReadInt(name string) (int64, error)

ReadInt reads the given sysctl parameter, return an int64 value.

func SetProcfs

func SetProcfs(path string)

SetProcfs sets path for the root's /proc. Calling it after GetProcfs causes panic.

func Write

func Write(name string, val string) error

Write writes the given sysctl parameter.

func WriteInt

func WriteInt(name string, val int64) error

WriteInt writes the given integer type sysctl parameter.

Types

type ErrInvalidSysctlParameter

type ErrInvalidSysctlParameter string

An ErrInvalidSysctlParameter is returned when a parameter is invalid.

func (ErrInvalidSysctlParameter) Error

func (e ErrInvalidSysctlParameter) Error() string

type Setting

type Setting struct {
	Name      string
	Val       string
	IgnoreErr bool

	// Warn if non-empty is the alternative warning log message to use when IgnoreErr is false.
	Warn string
}

Setting represents a sysctl setting. Its purpose it to be able to iterate over a slice of settings.