WshSmbConnector
The WSH (Windows Script Host) CLI that connects to SMB resources according to the schema defined in a JSON file.
Operating environment
Works on JScript in Windows.
Installation
Download this ZIP and unzip or Use the following git command.
D:\> git clone https://github.com/tuckn/WshSmbConnector.git
D:\> cd WshSmbConnector
Now suppose your directory structure looks like this.
D:\WshSmbConnector\
├─ .wsh\
│ └─ settings.json
└─ dist\
├─ Run.wsf
└─ bundle.js
Usage
Write Schema JSON
The JSON default path to load is %CD%.wsh\settings.json.
See .\.wsh\settings.json as example.
Write your connection schema in the JSON file, for example,
{
"smbConnectorSchema": {
"tasks": {
"home": {
"comp": "11.22.33.44",
"share": "Public",
"user": "user1",
"pwd": "user p@ss"
},
"office": {
"comp": "SV12345",
"share": "IPC$",
"domain": "ID123456",
"user": "user1",
"pwd": "user p@ss"
}
}
}
}
You can also define variables into components object.
The defined variable can be used as ${valName} in tasks.
{
"smbConnectorSchema": {
"components": {
"myUser": "user1",
"myPass": null
},
"tasks": {
"home": {
"comp": "11.22.33.44",
"share": "Public",
"user": "${myUser}",
"pwd": "${myPass}"
},
"office": {
"comp": "SV12345",
"share": "IPC$",
"domain": "ID123456",
"user": "${myUser}",
"pwd": "${myPass}"
}
}
}
}
The values specified as null in components must be specified CLI arguments.
Run with WSH
> cscript .\dist\Run.wsf schemaConnect * "myPass:user p@ss"
[2020-08-01T06:50:28] info taskName: "*"
[2020-08-01T06:50:28] info matched tasks: 2
[2020-08-01T06:50:28] info Start the function smbcn.connectSyncSurelyUsingLog
[2020-08-01T06:50:28] info Start the task: home
[2020-08-01T06:50:28] info Connecting to "11.22.33.44"
[2020-08-01T06:50:28] info shareName: "Public"
[2020-08-01T06:50:28] info domain: "", user: "user1"
[2020-08-01T06:50:28] info password: "****"
[2020-08-01T06:50:28] info throws: false
[2020-08-01T06:50:28] success Succeeded the connecting!
[2020-08-01T06:50:28] info Finished the function smbcn.connectSyncSurelyUsingLog
[2020-08-01T06:50:28] info Start the task: office
[2020-08-01T06:50:28] info Connecting to "SV12345"
[2020-08-01T06:50:28] info shareName: "IPC$"
[2020-08-01T06:50:28] info domain: "ID123456", user: "user1"
[2020-08-01T06:50:28] info password: "****"
[2020-08-01T06:50:28] info throws: false
[2020-08-01T06:50:28] success Succeeded the connecting!
[2020-08-01T06:50:28] info Finished the function smbcn.connectSyncSurelyUsingLog
Specify any tasks to run with property names.
> cscript .\dist\Run.wsf schemaConnect "home" "myPass:user p@ss"
[2020-08-01T06:50:28] info taskName: "home"
[2020-08-01T06:50:28] info matched tasks: 1
[2020-08-01T06:50:28] info Start the function smbcn.connectSyncSurelyUsingLog
[2020-08-01T06:50:28] info Start the task: home
[2020-08-01T06:50:28] info Connecting to "11.22.33.44"
[2020-08-01T06:50:28] info shareName: "Public"
[2020-08-01T06:50:28] info domain: "", user: "user1"
[2020-08-01T06:50:28] info password: "****"
[2020-08-01T06:50:28] info throws: false
[2020-08-01T06:50:28] success Succeeded the connecting!
[2020-08-01T06:50:28] info Finished the function smbcn.connectSyncSurelyUsingLog
Show the help.
> cscript .\dist\Run.wsf schemaConnect --help
Usage: schemaConnect <taskName> [overwriteKey:val...] [options]
The command to connect a Windows to resources with the schema
Options:
-V, --version Output the version number
-D, --dir-path <path> The path name where the schema JSON is located. <Directory Path> or "cwd", "portable", "userProfile". Default: "cmd" is "%CD%\\.wsh"
-F, --file-name <name> A JSON file name. (default: "settings.json")
-E, --encoding <name> The JSON file encoding. (default: "utf-8")
-N, --prop-name <name> A property name of the schema object. (default: "smbConnectorSchema")
-L, --logger <val> <level>/<transportation>. e.g. "warn/popup". (default: "info/console")
-H, --has-result Show a result(net use) (default: false)
-R, --dry-run No execute. Outputs the string of command. (default: false)
-h, --help Output usage information
See Wsh.ConfigStore for the options --dir-path and --file-name.
and see Wsh.Logger for the options --logger.
Installation as Module
(1) Create a directory of your WSH project.
D:\> mkdir MyWshProject
D:\> cd MyWshProject
(2) Download this ZIP and unzip or Use the following git command.
> git clone https://github.com/tuckn/WshSmbConnector.git ./WshModules/WshSmbConnector
or
> git submodule add https://github.com/tuckn/WshSmbConnector.git ./WshModules/WshSmbConnector
(3) Include .\WshSmbConnector\dist\bundle.js into your .wsf file.
For Example, if your file structure is
D:\MyWshProject\
├─ Run.wsf
├─ MyScript.js
└─ WshModules\
└─ WshSmbConnector\
└─ dist\
└─ bundle.js
The content of the above Run.wsf is
<package>
<job id = "run">
<script language="JScript" src="./WshModules/WshSmbConnector/dist/bundle.js"></script>
<script language="JScript" src="./MyScript.js"></script>
</job>
</package>
I recommend this WSH file (.wsf) encoding to be UTF-8 [BOM, CRLF].
Together with another Apps
If you want to use it together with another Apps, install as following
> git clone https://github.com/tuckn/WshBasicPackage.git ./WshModules/WshBasicPackage
> git clone https://github.com/tuckn/WshSmbConnector.git ./WshModules/WshSmbConnector
> git clone https://github.com/tuckn/WshDirBackUpper.git ./WshModules/WshDirBackUpper
or
> git submodule add https://github.com/tuckn/WshBasicPackage.git ./WshModules/WshBasicPackage
> git submodule add https://github.com/tuckn/WshSmbConnector.git ./WshModules/WshSmbConnector
> git submodule add https://github.com/tuckn/WshDirBackUpper.git ./WshModules/WshDirBackUpper
<package>
<job id = "run">
<script language="JScript" src="./WshModules/WshBasicPackage/dist/bundle.js"></script>
<script language="JScript" src="./WshModules/WshSmbConnector/dist/module.js"></script>
<script language="JScript" src="./WshModules/WshDirBackUpper/dist/module.js"></script>
<script language="JScript" src="./MyScript.js"></script>
</job>
</package>
Usage as Module
Now .\MyScript.js (JScript ) can use Wsh.SmbConnector.
Connecting and logging
var smbcn = Wsh.SmbConnector; // Shorthand
var comp = '11.22.33.44';
var share = 'public';
var domain = 'PCNAME';
var user = 'UserId';
var pwd = 'My * P@ss><';
smbcn.connectSyncSurelyUsingLog(comp, share, domain, user, pwd, {
logger: 'warn/winEvent', // See https://github.com/tuckn/WshLogger
showsResult: true
});
Schema Connecting
var smbcn = Wsh.SmbConnector; // Shorthand
var schema = {
smbConnectorSchema: {
components: {
myUser: 'user1',
myPass: null
},
tasks: {
home: {
comp: '11.22.33.44',
share: 'Public',
user: '${myUser}',
pwd: '${myPass}'
},
office: {
comp: 'SV12345',
share: 'IPC$',
domain: 'ID123456',
user: '${myUser}',
pwd: '${myPass}'
}
}
}
};
smbcn.connectSyncUsingSchema(schema, '*', {
logger: 'info/console',
overwrites: { myPass: 'user p@ss' },
isDryRun: true
});
Dependency Modules
You can also use tuckn/WshBasicPackage functions in .\MyScript.js (JScript).
Documentation
See all specifications here and also WshBasicPackage.
License
MIT
Copyright (c) 2020 Tuckn