network

Documentation

Index

• func Connect(ctx context.Context, networkName string, ...) error
• func Create(ctx context.Context, options entities.NetworkCreateOptions, name *string) (*entities.NetworkCreateReport, error)
• func Disconnect(ctx context.Context, networkName string, ...) error
• func Inspect(ctx context.Context, nameOrID string) ([]entities.NetworkInspectReport, error)
• func List(ctx context.Context, options entities.NetworkListOptions) ([]*entities.NetworkListReport, error)
• func Remove(ctx context.Context, nameOrID string, force *bool) ([]*entities.NetworkRmReport, error)

Functions

func Connect

func Connect(ctx context.Context, networkName string, options entities.NetworkConnectOptions) error

Connect adds a container to a network

func Create

func Create(ctx context.Context, options entities.NetworkCreateOptions, name *string) (*entities.NetworkCreateReport, error)

Create makes a new CNI network configuration

func Disconnect

func Disconnect(ctx context.Context, networkName string, options entities.NetworkDisconnectOptions) error

Disconnect removes a container from a given network

func Inspect

func Inspect(ctx context.Context, nameOrID string) ([]entities.NetworkInspectReport, error)

Inspect returns low level information about a CNI network configuration

func List

func List(ctx context.Context, options entities.NetworkListOptions) ([]*entities.NetworkListReport, error)

List returns a summary of all CNI network configurations

func Remove

func Remove(ctx context.Context, nameOrID string, force *bool) ([]*entities.NetworkRmReport, error)

Remove deletes a defined CNI network configuration by name. The optional force boolean will remove all containers associated with the network when set to true. A slice of NetworkRemoveReports are returned.