impl

Documentation

Index

• Constants
• type AddTargetPortalRequest
• type AddTargetPortalResponse
• type AuthenticationType
• type ConnectTargetRequest
• type ConnectTargetResponse
• type DisconnectTargetRequest
• type DisconnectTargetResponse
• type DiscoverTargetPortalRequest
• type DiscoverTargetPortalResponse
• type GetTargetDisksRequest
• type GetTargetDisksResponse
• type ListTargetPortalsRequest
• type ListTargetPortalsResponse
• type RemoveTargetPortalRequest
• type RemoveTargetPortalResponse
• type ServerInterface
• type SetMutualChapSecretRequest
• type SetMutualChapSecretResponse
• type TargetPortal
• type VersionedAPI

Constants

const (
	// No authentication is used
	NONE = 0

	// One way CHAP authentication. The target authenticates the initiator.
	ONE_WAY_CHAP = 1

	// Mutual CHAP authentication. The target and initiator authenticate each
	// other.
	MUTUAL_CHAP = 2
)

Types

type AddTargetPortalRequest

type AddTargetPortalRequest struct {
	// iSCSI Target Portal to register in the initiator
	TargetPortal *TargetPortal
}

type AddTargetPortalResponse

type AddTargetPortalResponse struct {
}

type AuthenticationType

type AuthenticationType uint32

type ConnectTargetRequest

type ConnectTargetRequest struct {
	// Target portal to which the initiator will connect.
	TargetPortal *TargetPortal

	// IQN of the iSCSI Target
	Iqn string

	// Connection authentication type, None by default
	//
	// One Way Chap uses the chap_username and chap_secret
	// fields mentioned below to authenticate the initiator.
	//
	// Mutual Chap uses both the user/secret mentioned below
	// and the Initiator Chap Secret to authenticate the target and initiator.
	AuthType AuthenticationType

	// CHAP Username used to authenticate the initiator
	ChapUsername string

	// CHAP password used to authenticate the initiator
	ChapSecret string
}

type ConnectTargetResponse

type ConnectTargetResponse struct {
}

type DisconnectTargetRequest

type DisconnectTargetRequest struct {
	// Target portal from which initiator will disconnect
	TargetPortal *TargetPortal
	// IQN of the iSCSI Target
	Iqn string
}

type DisconnectTargetResponse

type DisconnectTargetResponse struct {
}

type DiscoverTargetPortalRequest

type DiscoverTargetPortalRequest struct {
	// iSCSI Target Portal on which to initiate discovery
	TargetPortal *TargetPortal
}

type DiscoverTargetPortalResponse

type DiscoverTargetPortalResponse struct {
	// List of discovered IQN addresses
	// follows IQN format: iqn.yyyy-mm.naming-authority:unique-name
	Iqns []string
}

type GetTargetDisksRequest

type GetTargetDisksRequest struct {
	// Target portal whose disks will be queried
	TargetPortal *TargetPortal
	// IQN of the iSCSI Target
	Iqn string
}

type GetTargetDisksResponse

type GetTargetDisksResponse struct {
	// List composed of disk ids (numbers) that are associated with the
	// iSCSI target
	DiskIDs []string
}

type ListTargetPortalsRequest

type ListTargetPortalsRequest struct {
}

type ListTargetPortalsResponse

type ListTargetPortalsResponse struct {
	// A list of Target Portals currently registered in the initiator
	TargetPortals []*TargetPortal
}

type RemoveTargetPortalRequest

type RemoveTargetPortalRequest struct {
	// iSCSI Target Portal
	TargetPortal *TargetPortal
}

type RemoveTargetPortalResponse

type RemoveTargetPortalResponse struct {
}

type ServerInterface

type ServerInterface interface {
	AddTargetPortal(context.Context, *AddTargetPortalRequest, apiversion.Version) (*AddTargetPortalResponse, error)
	ConnectTarget(context.Context, *ConnectTargetRequest, apiversion.Version) (*ConnectTargetResponse, error)
	DisconnectTarget(context.Context, *DisconnectTargetRequest, apiversion.Version) (*DisconnectTargetResponse, error)
	DiscoverTargetPortal(context.Context, *DiscoverTargetPortalRequest, apiversion.Version) (*DiscoverTargetPortalResponse, error)
	GetTargetDisks(context.Context, *GetTargetDisksRequest, apiversion.Version) (*GetTargetDisksResponse, error)
	ListTargetPortals(context.Context, *ListTargetPortalsRequest, apiversion.Version) (*ListTargetPortalsResponse, error)
	RemoveTargetPortal(context.Context, *RemoveTargetPortalRequest, apiversion.Version) (*RemoveTargetPortalResponse, error)
	SetMutualChapSecret(context.Context, *SetMutualChapSecretRequest, apiversion.Version) (*SetMutualChapSecretResponse, error)
}

All the functions this group's server needs to define.

type SetMutualChapSecretRequest

type SetMutualChapSecretRequest struct {
	// the default CHAP secret that all initiators on this machine (node) use to
	// authenticate the target on mutual CHAP authentication.
	// Must be at least 12 byte long for non-Ipsec connections, at least one
	// byte long for Ipsec connections, and at most 16 bytes long.
	MutualChapSecret string
}

type SetMutualChapSecretResponse

type SetMutualChapSecretResponse struct {
}

type TargetPortal

type TargetPortal struct {
	// iSCSI Target (server) address
	TargetAddress string
	// iSCSI Target port (default iSCSI port is 3260)
	TargetPort uint32
}

type VersionedAPI

type VersionedAPI interface {
	Register(grpcServer *grpc.Server)
}