59 lines
2.0 KiB
Protocol Buffer
59 lines
2.0 KiB
Protocol Buffer
syntax = "proto3";
|
|
|
|
package v1;
|
|
|
|
option go_package = "github.com/kubernetes-csi/csi-proxy/client/api/smb/v1";
|
|
|
|
service Smb {
|
|
// NewSmbGlobalMapping creates an SMB mapping on the SMB client to an SMB share.
|
|
rpc NewSmbGlobalMapping(NewSmbGlobalMappingRequest) returns (NewSmbGlobalMappingResponse) {}
|
|
|
|
// RemoveSmbGlobalMapping removes the SMB mapping to an SMB share.
|
|
rpc RemoveSmbGlobalMapping(RemoveSmbGlobalMappingRequest) returns (RemoveSmbGlobalMappingResponse) {}
|
|
}
|
|
|
|
|
|
message NewSmbGlobalMappingRequest {
|
|
// 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.
|
|
string remote_path = 1;
|
|
|
|
// Optional local path to mount the smb on
|
|
string local_path = 2;
|
|
|
|
// Username credential associated with the share
|
|
string username = 3;
|
|
|
|
// Password credential associated with the share
|
|
string password = 4;
|
|
}
|
|
|
|
message NewSmbGlobalMappingResponse {
|
|
// Intentionally empty.
|
|
}
|
|
|
|
|
|
message RemoveSmbGlobalMappingRequest {
|
|
// 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.
|
|
string remote_path = 1;
|
|
}
|
|
|
|
message RemoveSmbGlobalMappingResponse {
|
|
// Intentionally empty.
|
|
}
|