Categorygithub.com/vishvananda/netns
modulepackage
0.0.5
Repository: https://github.com/vishvananda/netns.git
Documentation: pkg.go.dev

# README

netns - network namespaces in go

The netns package provides an ultra-simple interface for handling network namespaces in go. Changing namespaces requires elevated privileges, so in most cases this code needs to be run as root.

Local Build and Test

You can use go get command:

go get github.com/vishvananda/netns

Testing (requires root):

sudo -E go test github.com/vishvananda/netns

Example

package main

import (
    "fmt"
    "net"
    "runtime"

    "github.com/vishvananda/netns"
)

func main() {
    // Lock the OS Thread so we don't accidentally switch namespaces
    runtime.LockOSThread()
    defer runtime.UnlockOSThread()

    // Save the current network namespace
    origns, _ := netns.Get()
    defer origns.Close()

    // Create a new network namespace
    newns, _ := netns.New()
    defer newns.Close()

    // Do something with the network namespace
    ifaces, _ := net.Interfaces()
    fmt.Printf("Interfaces: %v\n", ifaces)

    // Switch back to the original namespace
    netns.Set(origns)
}

# Functions

DeleteNamed deletes a named network namespace.
Get gets a handle to the current threads network namespace.
GetFromDocker gets a handle to the network namespace of a docker container.
GetFromName gets a handle to a named network namespace such as one created by `ip netns add`.
GetFromPath gets a handle to a network namespace identified by the path.
GetFromPid gets a handle to the network namespace of a given pid.
GetFromThread gets a handle to the network namespace of a given pid and tid.
New creates a new network namespace, sets it as current and returns a handle to it.
NewNamed creates a new named network namespace, sets it as current, and returns a handle to it.
None gets an empty (closed) NsHandle.
Set sets the current network namespace to the namespace represented by NsHandle.
Setns sets namespace using golang.org/x/sys/unix.Setns.

# Constants

Get io context */.
New ipcs */.
New network namespace */.
New pid namespace */.
New user namespace */.
New utsname group? */.

# Type aliases

NsHandle is a handle to a network namespace.