hcnshim

README

hcnshim

This package provides the Golang interface for accessing Windows HCN APIs to manage entities within the Host Network Service (HNS), which serves as the server container networking component in Windows. While it is mainly utilized by the Windows Kube Proxy component in Kubernetes, it is also available for use in other projects, such as Azure CNI, Windows CNI, Calico CNI, Flannel CNI, Azure NPM, and more.

Documentation

Index

• Variables
• func HotAttachEndpoint(containerID string, endpointID string) error
• func HotDetachEndpoint(containerID string, endpointID string) error
• type EndpointAttachDetachRequest
• type EndpointResquestResponse
• type HNSAclFeatures
• type HNSEndpoint
  • func GetHNSEndpointByID(endpointID string) (*HNSEndpoint, error)
  • func GetHNSEndpointByName(endpointName string) (*HNSEndpoint, error)
  • func HNSEndpointRequest(method, path, request string) (*HNSEndpoint, error)
  • func HNSListEndpointRequest() ([]HNSEndpoint, error)
• type HNSEndpointStats
  • func GetHNSEndpointStats(endpointName string) (*HNSEndpointStats, error)
• type HNSGlobals
  • func GetHNSGlobals() (*HNSGlobals, error)
• type HNSNetwork
  • func GetHNSNetworkByID(networkID string) (*HNSNetwork, error)
  • func GetHNSNetworkByName(networkName string) (*HNSNetwork, error)
  • func HNSListNetworkRequest(method, path, request string) ([]HNSNetwork, error)
  • func HNSNetworkRequest(method, path, request string) (*HNSNetwork, error)
• type HNSNnvManagementMacAddress
• type HNSNnvManagementMacList
  • func DeleteNnvManagementMacAddresses() (*HNSNnvManagementMacList, error)
  • func GetNnvManagementMacAddresses() (*HNSNnvManagementMacList, error)
  • func SetNnvManagementMacAddresses(managementMacAddresses []string) (*HNSNnvManagementMacList, error)
• type HNSSupportedFeatures
  • func GetHNSSupportedFeatures() HNSSupportedFeatures
• type HNSVersion
• type MacPool
• type Namespace
• type Subnet
• type SystemType

Variables

var (
	ErrorEmptyMacAddressList = errors.New("management mac_address list is empty")
)

var (
	HNSVersion1803 = hns.HNSVersion1803
)

Functions

func HotAttachEndpoint

func HotAttachEndpoint(containerID string, endpointID string) error

HotAttachEndpoint makes a HCS Call to attach the endpoint to the container

func HotDetachEndpoint

func HotDetachEndpoint(containerID string, endpointID string) error

HotDetachEndpoint makes a HCS Call to detach the endpoint from the container

Types

type EndpointAttachDetachRequest

type EndpointAttachDetachRequest = hns.EndpointAttachDetachRequest

EndpointAttachDetachRequest is the structure used to send request to the container to modify the system Supported resource types are Network and Request Types are Add/Remove

type EndpointResquestResponse

type EndpointResquestResponse = hns.EndpointResquestResponse

EndpointResquestResponse is object to get the endpoint request response

type HNSAclFeatures

type HNSAclFeatures = hns.HNSAclFeatures

type HNSEndpoint

type HNSEndpoint = hns.HNSEndpoint

HNSEndpoint represents a network endpoint in HNS

func GetHNSEndpointByID

func GetHNSEndpointByID(endpointID string) (*HNSEndpoint, error)

GetHNSEndpointByID get the Endpoint by ID

func GetHNSEndpointByName

func GetHNSEndpointByName(endpointName string) (*HNSEndpoint, error)

GetHNSEndpointByName gets the endpoint filtered by Name

func HNSEndpointRequest

func HNSEndpointRequest(method, path, request string) (*HNSEndpoint, error)

HNSEndpointRequest makes a HNS call to modify/query a network endpoint

func HNSListEndpointRequest

func HNSListEndpointRequest() ([]HNSEndpoint, error)

HNSListEndpointRequest makes a HNS call to query the list of available endpoints

type HNSEndpointStats

type HNSEndpointStats = hns.EndpointStats

HNSEndpointStats represent the stats for an networkendpoint in HNS

func GetHNSEndpointStats

func GetHNSEndpointStats(endpointName string) (*HNSEndpointStats, error)

GetHNSEndpointStats gets the endpoint stats by ID

type HNSGlobals

type HNSGlobals = hns.HNSGlobals

func GetHNSGlobals

func GetHNSGlobals() (*HNSGlobals, error)

type HNSNetwork

type HNSNetwork = hns.HNSNetwork

HNSNetwork represents a network in HNS

func GetHNSNetworkByID

func GetHNSNetworkByID(networkID string) (*HNSNetwork, error)

GetHNSNetworkByID

func GetHNSNetworkByName

func GetHNSNetworkByName(networkName string) (*HNSNetwork, error)

GetHNSNetworkName filtered by Name

func HNSListNetworkRequest

func HNSListNetworkRequest(method, path, request string) ([]HNSNetwork, error)

HNSListNetworkRequest makes a HNS call to query the list of available networks

func HNSNetworkRequest

func HNSNetworkRequest(method, path, request string) (*HNSNetwork, error)

HNSNetworkRequest makes a call into HNS to update/query a single network

type HNSNnvManagementMacAddress

type HNSNnvManagementMacAddress = hns.HNSNnvManagementMacAddress

HNSNnvManagementMacAddress represents management mac address which needs to be excluded from VF reassignment

type HNSNnvManagementMacList

type HNSNnvManagementMacList = hns.HNSNnvManagementMacList

HNSNnvManagementMacList represents a list of management mac addresses for exclusion from VF reassignment

func DeleteNnvManagementMacAddresses

func DeleteNnvManagementMacAddresses() (*HNSNnvManagementMacList, error)

DeleteNnvManagementMacAddresses delete list of management mac addresses in hns which are excluded from VF reassignment.

func GetNnvManagementMacAddresses

func GetNnvManagementMacAddresses() (*HNSNnvManagementMacList, error)

GetNnvManagementMacAddresses retrieves a list of management mac addresses in hns for exclusion from VF reassignment.

func SetNnvManagementMacAddresses

func SetNnvManagementMacAddresses(managementMacAddresses []string) (*HNSNnvManagementMacList, error)

SetNnvManagementMacAddresses sets a list of management mac addresses in hns for exclusion from VF reassignment.

type HNSSupportedFeatures

type HNSSupportedFeatures = hns.HNSSupportedFeatures

func GetHNSSupportedFeatures

func GetHNSSupportedFeatures() HNSSupportedFeatures

type HNSVersion

type HNSVersion = hns.HNSVersion

type MacPool

type MacPool = hns.MacPool

MacPool is associated with a network and represents a list of macaddresses available to the network

type Namespace

type Namespace = hns.Namespace

Namespace represents a Compartment.

type Subnet

type Subnet = hns.Subnet

Subnet is associated with a network and represents a list of subnets available to the network

type SystemType

type SystemType string

SystemType represents the type of the system on which actions are done

const (
	ContainerType      SystemType = "Container"
	VirtualMachineType SystemType = "VirtualMachine"
	HostType           SystemType = "Host"
)

SystemType const