ipam

Documentation

Index

• type AddressManager
• type AllocateIPRequest
• type CreateIpamSubnetRequest
• type DeallocateIPRequest
• type DeleteIpamSubnetRequest
• type ErrSubnetExhausted
• type IsIPAllocatedRequest

Types

type AddressManager

type AddressManager interface {
	// TODO: extend this interface with additional methods if necessary.
	//		Most likely following methods are going to be required:
	//			- network create/delete
	AllocateIP(context.Context, *AllocateIPRequest) (address string, subnetUUID string, err error)
	DeallocateIP(context.Context, *DeallocateIPRequest) (err error)
	IsIPAllocated(context.Context, *IsIPAllocatedRequest) (isAllocated bool, err error)
	CreateIpamSubnet(context.Context, *CreateIpamSubnetRequest) (subnetUUID string, err error)
	CheckIfIpamSubnetExists(ctx context.Context, subnetUUID string) (bool, error)
	DeleteIpamSubnet(context.Context, *DeleteIpamSubnetRequest) (err error)
}

AddressManager address manager interface for virtual network

type AllocateIPRequest

type AllocateIPRequest struct {
	VirtualNetwork               *models.VirtualNetwork
	SubnetUUID                   string
	IPAddress                    string
	IPFamily                     string
	VirtualRouterNetworkIpamRefs []*models.VirtualRouterNetworkIpamRef
	InstanceIPNetworkIpamRefs    []*models.InstanceIPNetworkIpamRef
}

AllocateIPRequest arguments for AllocateIP methods.

type CreateIpamSubnetRequest

type CreateIpamSubnetRequest struct {
	IpamSubnet *models.IpamSubnetType
}

CreateIpamSubnetRequest arguments for CreateIpamSubnet methods.

type DeallocateIPRequest

type DeallocateIPRequest struct {
	VirtualNetwork *models.VirtualNetwork
	IPAddress      string
	IpamRefs       []*models.InstanceIPNetworkIpamRef
}

DeallocateIPRequest arguments for DeallocateIP methods.

type DeleteIpamSubnetRequest

type DeleteIpamSubnetRequest struct {
	SubnetUUID string
}

DeleteIpamSubnetRequest arguments for DeleteIpamSubnet methods.

type ErrSubnetExhausted

type ErrSubnetExhausted interface {
	SubnetExhausted()
}

ErrSubnetExhausted signals that address cannot be allocated since subnet is exhausted

type IsIPAllocatedRequest

type IsIPAllocatedRequest struct {
	VirtualNetwork *models.VirtualNetwork
	IPAddress      string
}

IsIPAllocatedRequest arguments for IsIPAllocated methods.