CLI

CLI

Source:

Below are the APIs of CLI (Command Line Interface). Some inappropriate titles are used because they are generated by JsDoc.

Methods

(static) connect()

Source:

Connects the specifying resource.

Example
Usage: connect <compName> [options]

The command to connect a Windows to the resource

Options:
  -V, --version        Output the version number
  -S, --shared <name>  A shared name of the resource. Default: "IPC$"
  -D, --domain <name>  A domain of the user
  -U, --user <name>    A user name to log on
  -P, --pwd <password> A password of the user
  -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

(static) disconnect()

Source:

Disconnects the specifying resource.

Example
Usage: disconnect [compName] [options]

The command to disconnect a Windows from the resource

Options:
  -V, --version       Output the version number
  -S, --shared <name> A shared name of the resource. Default: "IPC$"
  -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

(static) schemaConnect()

Source:

Connects the resources defined on a schema.

Example
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