smb

Documentation

Index

• type Interface
• type NewSMBGlobalMappingRequest
• type NewSMBGlobalMappingResponse
• type RemoveSMBGlobalMappingRequest
• type RemoveSMBGlobalMappingResponse
• type SMB
  • func New(hostAPI smbapi.HostAPI, fsClient fs.Interface) (*SMB, error)
  • func (s *SMB) NewSMBGlobalMapping(context context.Context, request *NewSMBGlobalMappingRequest) (*NewSMBGlobalMappingResponse, error)
  • func (s *SMB) RemoveSMBGlobalMapping(context context.Context, request *RemoveSMBGlobalMappingRequest) (*RemoveSMBGlobalMappingResponse, error)

Types

type Interface

type Interface interface {
	// NewSMBGlobalMapping creates an SMB mapping on the SMB client to an SMB share.
	NewSMBGlobalMapping(context.Context, *NewSMBGlobalMappingRequest) (*NewSMBGlobalMappingResponse, error)

	// RemoveSMBGlobalMapping removes the SMB mapping to an SMB share.
	RemoveSMBGlobalMapping(context.Context, *RemoveSMBGlobalMappingRequest) (*RemoveSMBGlobalMappingResponse, error)
}

type NewSMBGlobalMappingRequest

type NewSMBGlobalMappingRequest struct {
	// A remote SMB share to mount
	// All unicode characters allowed in SMB server name specifications are
	// permitted except for restrictions below
	//
	// Restrictions:
	// SMB remote path specified in the format: \\server-name\sharename, \\server.fqdn\sharename or \\a.b.c.d\sharename
	// If not an IP address, share name has to be a valid DNS name.
	// UNC specifications to local paths or prefix: \\?\ is not allowed.
	// Characters: + [ ] " / : ; | < > , ? * = $ are not allowed
	RemotePath string

	// Optional local path to mount the SMB on
	LocalPath string

	// Username credential associated with the share
	Username string

	// Password credential associated with the share
	Password string
}

type NewSMBGlobalMappingResponse

type NewSMBGlobalMappingResponse struct {
}

type RemoveSMBGlobalMappingRequest

type RemoveSMBGlobalMappingRequest struct {
	// A remote SMB share mapping to remove
	// All unicode characters allowed in SMB server name specifications are
	// permitted except for restrictions below
	//
	// Restrictions:
	// SMB share specified in the format: \\server-name\sharename, \\server.fqdn\sharename or \\a.b.c.d\sharename
	// If not an IP address, share name has to be a valid DNS name.
	// UNC specifications to local paths or prefix: \\?\ is not allowed.
	// Characters: + [ ] " / : ; | < > , ? * = $ are not allowed
	RemotePath string
}

type RemoveSMBGlobalMappingResponse

type RemoveSMBGlobalMappingResponse struct {
}

type SMB

type SMB struct {
	// contains filtered or unexported fields
}

func New

func New(hostAPI smbapi.HostAPI, fsClient fs.Interface) (*SMB, error)

func (*SMB) NewSMBGlobalMapping

func (s *SMB) NewSMBGlobalMapping(context context.Context, request *NewSMBGlobalMappingRequest) (*NewSMBGlobalMappingResponse, error)

func (*SMB) RemoveSMBGlobalMapping

func (s *SMB) RemoveSMBGlobalMapping(context context.Context, request *RemoveSMBGlobalMappingRequest) (*RemoveSMBGlobalMappingResponse, error)