Return to Blocky FAQ Pricing Contact

Appx B: BlockyCLI parameters

Appx B: BlockyCLI parameters

BlockyCli.exe is a command-line utility for BlockyforVeeam® to manage access control, licenses, and password. It is located in the BlockyforVeeam® installation path.

Membership in the local Administrators group, or equivalent, is recommended to run the BlockyCli. For non-admin users, several privileges must be assigned. For more information, see the chapter Missing privileges. An elevated command prompt is required to gain these privileges.

Access control commands:

Syntax:

BlockyCli { <password> | -p | -i <pwdfile> }<command><parameter>

The self-defined password is required for all access control commands.

Parameters:

Password parameterDescription

<password>

supply password on command line

-p

let CLI prompt for password.

-i <pwdfile>

supply password via given input file.

Management commandParametersDescription

set_accesscontrol

<path>

Activate access control on provided path.

reset_accesscontrol

<path>

Deactivate access control on provided path.

reset_accesscontrol

<path> <n>

Deactivate access control on path temporarily for <n> minutes [1..60]

show_controlledfolders

<path>

Display if access control is in path active.

show_contolledfolders

ALL

Display all controlled folders.

add_whitelist

<program>

Add program to whitelist.

del_whitelist

<program>

Remove program from whitelist.

update_whitelist

<program>

Update program in whitelist.

show_whitelist

Show whitelisted objects.

diagnostics

generate diagnostics report.

dump

Dumps program whitelist and access table.

Examples:

Access control

.\BlockyCli.exe password20 show_controlledfolders ALL

Controlled Folders: (0) rc:0

.\BlockyCli.exe password20 set_accesscontrol E:\privat rc:0

.\BlockyCli.exe password20 show_controlledfolders ALL

Controlled Folders: (1) E:\privat rc:0

.\BlockyCli.exe password20 show_controlledfolders E:\privat Access Control is active on E:\privat rc:0

.\BlockyCli.exe password20 show_controlledfolders E:\protect Access Control is not active on E:\protect rc:0

.\BlockyCli.exe password20 reset_accesscontrol E:\privat 10 rc:0

Whitelist

.\BlockyCli.exe password20 add_whitelist

C:\Windows\System32\notepad.exe rc:0

.\BlockyCli.exe password20 show_whitelist

WhiteListed Applications:

C:\Windows\System32\notepad.exe rc:0

.\BlockyCli.exe password20 del_whitelist

C:\Windows\System32\notepad.exe rc:0

.\BlockyCli.exe password20 update_whitelist

C:\Windows\System32\notepad.exe, +rc:0

Diagnostics

.\BlockyCli.exe password20

diagnostics Generating Diagnostics

Report …………… rc:0

This creates the service report file C:\ProgramData\GrauData\Blocky\BlockyforVeeam®_Diag.zip.

Dump

.\BlockyCli.exe password20 dump

rc:0

This creates the following files in the folder C:\ProgramData\GrauData\Blocky\:

  • AccessTable.txt

  • WhiteListDump.txt

License handling commands:

Syntax:

BlockyCli { <password> | -p | -i <pwdfile> }<command><parameter>

The self defined password is required for all license handling commands.

Parameters:

Password parameterDescription

<password>

supply password on command line

-p

let CLI prompt for password.

-i <pwdfile>

supply password via given input file.

Management command ParametersDescription

request_license

<vol_path> | <vol_guid> [ -f license-file.txt ] [ -c CapID ]

get license request for volume.

install_license license-

{ -f license-file.txt | -k

key-string }

install license key.

show_license

[-f output-file.csv]

show licenses of all controlled volumes.

Examples:

Request License

.\BlockyCli.exe password20 request_license E: -c

AAAA-BBBB-CCCC-3333-5555-ZZZZ-XXXX

+M8SU-MJZY-R94W-WZ9V-J4MF-YMX6-A9HS-2C4V-VZXW-NW4Z-EFDJ-6W57-FVIX-E5G6-69HV- BUDJ-FT7P-CEV5-RGDS-TUX7-4YJX-V6NS-KJR4-GVC2-P4HQ-G9CZ-8IET-S6XY-Q8KV-RJGE-UMU3- ATD2-G5J7-8VRN-S7XF-CINP-6T2G-6RTR-AN9C-MDJX-9AHK-QYGG-ZV5X-7CCM-FT8J-7PAH-AP54- 4AJQ-W9WW-GX52-VFD4-PCDP-ASM3-S9HG-A8RA-8XFG-5Q6S-JAA

rc:0

.\BlockyCli.exe password20 request_license E: -f

request-file.txt rc:0 +v

.\BlockyCli.exe password20 request_license "\\?\Volume{fc7c96de-0000-0000-0000-010000011000}\"

M7SU-MJZY-R94W-WZ9V-J4MF-YMX6-A9HS-2C4V-VZXW-NW4Z-EFDJ-6W57-FVIX-E5G6-69HV-

BUDJ-FT7P-CEV5-RGDS-TUX7-4YJX-V6NS-KJR4-GVC2-P4HQ-G9CZ-8IET-S6XY-Q8KV-RJGE-UMU3- ATD2-G5J7-8VRN-S7XF-CINP-6T2G-6RTR-AN9C-MDJX-9AHK-QYGG-ZV5X-7CCM-FT8J-7PAH-AP54- 4AJQ-W9WW-GX52-VFD4-PCDP-ASM3-S9HG-A8RA-8XFG-5Q6S-JAA

rc:0

The request_license command only generates a license request key. Please proceed with resulting license request by using Web-Portal or e-mail. See chapter Licensing.

For initial licensing request, a valid Cap-ID must be supplied with parameter "-c". For license renewal, this parameter should be omitted.

When Volume is supplied as volume GUID, this must be enclosed in single or double quotes.

Install License

.\BlockyCli.exe password20 install_license -f

LicKey-20210713-115523.txt rc:0

.\BlockyCli.exe password20 install_license -k

4MXB-E8VU-Z9XS-6YCM-3ACK-QSBD-WCVH- QFE7-TPMM-SQUJ-7AZH-TAW9-FEBD-F3CN-CX7D-PAZA-C48Z-ZM6I-JUG4-YI4R-PKST-IIGW- BA5D-6MWB-RSHD-M7XG-YEWW-559C-DUR5-V7R5-3MNR-AZXT-JKFJ-7P3S-ATYN-BHNQ-6VDT-RMUK-PPR8-8ZWV-E43T-WB5R-7WMU-CHDW-M8ZS

rc:0

Show License

.\BlockyCli.exe password20 show_license VolumeGUID,MountPoint,VolumeKey,LicenseType,ExpirationDate,LicensedCapacity,TotalCapacity,UsedCapacity

\\?\Volume{6e65ff6d-7d86-4f90-9eb1-f3b55087b321}\,F:\,01053782,C,2023-01- 17,10240,10220,1024

\\?\Volume{fc7c96de-0600-0200-0300-010000000000}\,G:\,02021BCB,C,2022-01- 02,20480,18384,2048

rc:0

.\BlockyCli.exe password20 show_license -f

output-file.csv rc:0

Change password command:

Syntax:

BlockyCli { <password> | -p | -i <pwdfile> }<command><parameter>

The self defined password is required for change password command.

Parameters:

Password parameterDescription

<password>

supply password on command line

-p

let CLI prompt for current password.

-i <pwdfile>

supply current password via given input file.

Management commandParametersDescription

change_password

[ <new_password> | -n <new_pwdfile> ]

change password.

Examples:

Change password

.\BlockyCli.exe password20 change_password MyNewP4ssw0rd Password has been successfully changed.

rc:0

.\BlockyCli.exe password20 change_password -n pwdfile.txt Password has been successfully changed.

rc:0

Initial password and password reset

CommandDescription

BlockyCli set_password <password>

Sets the initial password.

BlockyCli request_password_reset

Creates a token for requesting a password reset key.

BlockyCli reset_password <reset_key>

Resets the password with the provided reset key.

Examples:

Set password

.\BlockyCli.exe set_password password20 rc:0

Request password

.\BlockyCli.exe request_password_reset

Send the following token to [email protected] order receive a password reset key:

H9KC-CS2K-KSJR-L87T-N6ES-OX3T-U5TR-YWA4-BAN6-7ANG-26ZG-P2QD-3EX2-BB7H-J2RM- 2VXT-7IE6-4NE8-6GY4-5K9Q-5ZZ4-QAMG-WDP9-AG87-2IVU-5K4V-X4CT-UID7-KT6E-8IXH-VTH4-48TS

Reset password

.\BlockyCli.exe reset_password

OD9C-OUR5-KSFR-L8OT-XKLS-OX3T-U5TR-YWA4-BAN6-7ANG- 26ZG-P2QD-3EX2-BB7H-J2RM-2VXT-7IE6-4NE8-6GY4-5K9Q-5ZZ4-QAMG-WDP9-AG87-2JUS-5K4V-X4CT-UID7-KT6E-8IXH-VTH4-IO0P

rc:0

PreviousAppx A: Setup command line parametersNextAppx C: BlockyforVeeam® Change Log

Last updated