Skip to content

Latest commit

 

History

History
54 lines (35 loc) · 2.52 KB

smb_v1.md

File metadata and controls

54 lines (35 loc) · 2.52 KB

CSI Proxy SMB v1 API

Table of Contents

v1 SMB RPCs

Method Name Request Type Response Type Description
NewSmbGlobalMapping NewSmbGlobalMappingRequest NewSmbGlobalMappingResponse NewSmbGlobalMapping creates an SMB mapping on the SMB client to an SMB share.
RemoveSmbGlobalMapping RemoveSmbGlobalMappingRequest RemoveSmbGlobalMappingResponse RemoveSmbGlobalMapping removes the SMB mapping to an SMB share.

Top

v1 SMB Messages

NewSmbGlobalMappingRequest

Field Type Label Description
remote_path string A remote SMB share to mount All unicode characters allowed in SMB server name specifications are permitted except for restrictions below
local_path string Optional local path to mount the smb on
username string Username credential associated with the share
password string Password credential associated with the share

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.

NewSmbGlobalMappingResponse

Intentionally empty.

RemoveSmbGlobalMappingRequest

Field Type Label Description
remote_path string 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.

RemoveSmbGlobalMappingResponse

Intentionally empty.