# Appx B: BlockyCLI parameters

## Appx B: BlockyCLI parameters <a href="#heading-h.xvir7l" id="heading-h.xvir7l"></a>

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:**

{% hint style="info" %}
BlockyCli  { \<password>  | -p  | -i \<pwdfile>  }\<command>\<parameter>
{% endhint %}

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

**Parameters:**

| Password parameter | Description                           |
| ------------------ | ------------------------------------- |
| **\<password>**    | supply password on command line       |
| **-p**             | let CLI prompt for password.          |
| **-i \<pwdfile>**  | supply password via given input file. |

<table><thead><tr><th>Management command</th><th width="134.33333333333334">Parameters</th><th>Description</th></tr></thead><tbody><tr><td><strong>set_accesscontrol</strong></td><td><strong>&#x3C;path></strong></td><td>Activate access control on provided path.</td></tr><tr><td><strong>reset_accesscontrol</strong></td><td><strong>&#x3C;path></strong></td><td>Deactivate access control on provided path.</td></tr><tr><td><strong>reset_accesscontrol</strong></td><td><strong>&#x3C;path> &#x3C;n></strong></td><td>Deactivate access control on path temporarily for &#x3C;n> minutes [1..60]</td></tr><tr><td><strong>show_controlledfolders</strong></td><td><strong>&#x3C;path></strong></td><td>Display if access control is in path active.</td></tr><tr><td><strong>show_contolledfolders</strong></td><td><strong>ALL</strong></td><td>Display all controlled folders.</td></tr><tr><td><strong>add_whitelist</strong></td><td><strong>&#x3C;program></strong></td><td>Add program to whitelist.</td></tr><tr><td><strong>del_whitelist</strong></td><td><strong>&#x3C;program></strong></td><td>Remove program from whitelist.</td></tr><tr><td><strong>update_whitelist</strong></td><td><strong>&#x3C;program></strong></td><td>Update program in whitelist.</td></tr><tr><td><strong>show_whitelist</strong></td><td></td><td>Show whitelisted objects.</td></tr><tr><td><strong>diagnostics</strong></td><td></td><td>generate diagnostics report.</td></tr><tr><td><strong>dump</strong></td><td></td><td>Dumps program whitelist and access table.</td></tr></tbody></table>

**Examples:**

*<mark style="color:red;">Access control</mark>*

{% hint style="info" %}
.\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
{% endhint %}

*<mark style="color:red;">Whitelist</mark>*

{% hint style="info" %}
.\BlockyCli.exe   password20   **add\_whitelist**  &#x20;

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

.\BlockyCli.exe password20 **show\_whitelist**

WhiteListed     Applications:&#x20;

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
{% endhint %}

*<mark style="color:red;">Diagnostics</mark>*

{% hint style="info" %}
.\BlockyCli.exe        password20&#x20;

**diagnostics** Generating Diagnostics&#x20;

Report …………… rc:0
{% endhint %}

This creates the service report file <mark style="color:red;">C:\ProgramData\GrauData\Blocky\BlockyforVeeam®\_Diag.zip.</mark>

*<mark style="color:red;">Dump</mark>*

{% hint style="info" %}
.\BlockyCli.exe     password20     **dump**

rc:0
{% endhint %}

This creates the following files in the folder <mark style="color:red;">C:\ProgramData\GrauData\Blocky\\:</mark>

* AccessTable.txt
* WhiteListDump.txt

**License handling commands:**

**Syntax:**

{% hint style="info" %}
BlockyCli  { \<password>  | -p  | -i \<pwdfile>  }\<command>\<parameter>
{% endhint %}

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

**Parameters:**

| Password parameter | Description                           |
| ------------------ | ------------------------------------- |
| **\<password>**    | supply password on command line       |
| **-p**             | let CLI prompt for password.          |
| **-i \<pwdfile>**  | supply password via given input file. |

<table><thead><tr><th>Management command </th><th width="253">Parameters</th><th>Description</th></tr></thead><tbody><tr><td><strong>request_license</strong></td><td><strong>&#x3C;vol_path> | &#x3C;vol_guid> [ -f license-file.txt ] [ -c CapID ]</strong></td><td>get license request for volume.</td></tr><tr><td><strong>install_license</strong><br><strong>license-</strong></td><td><p><strong>{ -f license-file.txt | -k</strong></p><p><br><strong>key-string }</strong></p></td><td>install license key.</td></tr><tr><td><strong>show_license</strong></td><td> <strong>[-f output-file.csv]</strong></td><td>show licenses of all controlled volumes.</td></tr></tbody></table>

**Examples:**

*<mark style="color:red;">Request License</mark>*

{% hint style="info" %}
.\BlockyCli.exe     password20     **request\_license**     E:     -c    &#x20;

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&#x20;

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
{% endhint %}

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.](https://docs.blockyforveeam.com/administration-guide/pages/fl1Sonb4mYrtJqbcUIjb#4.14-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.

*<mark style="color:red;">Install License</mark>*

{% hint style="info" %}
.\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
{% endhint %}

*<mark style="color:red;">Show License</mark>*

{% hint style="info" %}
.\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   &#x20;

output-file.csv rc:0
{% endhint %}

**Change password command:**

**Syntax:**

{% hint style="info" %}
BlockyCli  { \<password>  | -p  | -i \<pwdfile>  }\<command>\<parameter>
{% endhint %}

The self defined password is required for change password command.

**Parameters:**

<table><thead><tr><th width="240.5">Password parameter</th><th>Description</th></tr></thead><tbody><tr><td><strong>&#x3C;password></strong></td><td>supply password on command line</td></tr><tr><td><strong>-p</strong></td><td>let CLI prompt for current password.</td></tr><tr><td><strong>-i &#x3C;pwdfile></strong></td><td>supply current password via given input file.</td></tr></tbody></table>

&#x20;&#x20;

| Management command | Parameters                                  | Description      |
| ------------------ | ------------------------------------------- | ---------------- |
| change\_password   | \[ \<new\_password> \| -n \<new\_pwdfile> ] | change password. |

**Examples:**

*<mark style="color:red;">Change password</mark>*

{% hint style="info" %}
.\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
{% endhint %}

**Initial password and password reset**

| Command                                     | Description                                          |
| ------------------------------------------- | ---------------------------------------------------- |
| 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:**

*<mark style="color:red;">Set password</mark>*

{% hint style="info" %}
.\BlockyCli.exe   **set\_password**\
password20 rc:0
{% endhint %}

*<mark style="color:red;">Request password</mark>*

{% hint style="info" %}
.\BlockyCli.exe       **request\_password\_reset**

Send the following token to <support@graudata.comin> 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
{% endhint %}

*<mark style="color:red;">Reset password</mark>*

{% hint style="info" %}
.\BlockyCli.exe       **reset\_password**   <br>

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
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.blockyforveeam.com/administration-guide/appx-b-blockycli-parameters.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.