Ticket #320: readme.smb

File readme.smb, 2.7 KB (added by Lewis Rosenthal, 6 years ago)

Initial REXX readme for the 3.0 plugin (includes authentication and encryption options)

Line 
1The available parameters for src and their default values are:
2
3Strings:
4
5workgroup - The name of the workgroup or domain of the server.
6
7    Default: blank
8 
9
10server - The name or IP address of the server hosting the resource
11(share).
12
13    Default: blank
14 
15
16share - The name of the desired server resource (share).
17
18    Default: blank
19 
20
21user - The username for authentication.
22
23    Default: guest
24 
25
26password - The password of the selected user.
27
28    Default: blank
29 
30
31spassword - The share-level password of the selected user.
32
33    Default: blank
34
35
36master - The name of the browse master server or workgroup, used to
37get the list of available workgroups when the workgroup and server
38have not been specified.
39
40    Default: WORKGROUP
41 
42
43mastertype - The type of master selected (1 = workgroup; 0 = server)
44
45    Default: 1
46 
47
48cto - The time in seconds for which the cache is valid. Once the
49timeout is reached, the client re-reads the directory. For a
50directory with many files, it may be better to increase the timeout
51(rule of thumb: per 500-800 files 10 seconds). Max: 600
52
53    Default: 10
54 
55
56cld - The number of directories the cache should hold. Be aware that
57the higher the value, the more memory consumed. Max: 96
58
59    Default: 32
60 
61
62easupport - (Boolean) Support OS/2 Extended Attributes in the target
63filesystem (and by the target server).
64
65    Default: 1
66
67
68krb5support - (Boolean) Support Kerberos authentication. You will
69need to have a valid ticket for this resource. If enabled, User ID
70and Password are ignored.
71
72Note: If 1, ntlmv1support must be 0
73
74    Default: 0
75
76
77ntlmv1support - (Boolean) Authenticate using the older NTLM protocol.
78Newer Samba releases default to NTLMv2, which may not be understood
79by some older servers.
80
81Note: If 1, KRB5 and supportencryption must both be 0
82
83    Default: 0
84
85
86encryptionsupport - (Boolean) Enable transport encryption over SMB3
87links. Although Samba servers have supported encrypted transport
88connections using the UNIX extensions for many years, selecting SMB3
89transport allows encrypted transport connections to Windows servers
90that support SMB3, as well as Samba servers.
91
92Note: If 1, ntlmv1support must be 0
93
94    Default: 0
95
96
97Example:
98
99src = 'workgroup=homegroup;server=192.168.178.2;share=data; \
100       user=test;password=pass;spassword=;master=homegroup; \
101       mastertype=1;cto=30;cld=64;easupport=1;krb5support=0; \
102       ntlmv1support=0;encryptionsupport=1'
103       
104This assumes a Samba resource of \\192.168.178.2\data using NTLMv2
105authentication over SMB3 supporting encryption, with support for
106extended attributes in the target filesystem and by the Samba host
107server, in the homegroup workgroup.