File Share List resources protect Windows SMB (Server Message Block) file shares. When a failover occurs, the file shares are recreated on the standby server, allowing clients to reconnect to the same share paths.
Resource Type: comm/volshare
Aliases: volshare
Subcommands
File Share List resources are managed by commands of the form:
lkcli resource comm/volshare <subcommand> [flags]
| Subcommand | Description | Required Role |
|---|---|---|
create |
Create a new Volume Share resource | admin |
extend |
Extend to a standby server | admin |
get-property |
Read a resource property | guest |
set-property |
Update an editable resource property | admin |
create
lkcli resource comm/volshare create --file-share-list=<object> [flags]
| Flag | Short | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|---|
--file-share-list |
— | object | Yes | — | name=path pairs, comma-separated |
File shares to protect; specify as ShareName=\\Path pairs (e.g., Data=E:\Data,Logs=E:\Logs) |
--tag |
— | string | No | Auto-generated | — | Resource tag name |
--switchback |
— | enum | No | INTELLIGENT |
INTELLIGENT, AUTOMATIC |
Switchback type |
--deepcheck-interval |
— | int | No | 300 |
min: 0, max: 604800 | Deepcheck interval in seconds |
--quickcheck-interval |
— | int | No | 180 |
min: 0, max: 604800 | Quickcheck interval in seconds |
--local-recovery |
— | enum | No | enabled |
enabled, disabled |
Enable local recovery |
extend
lkcli resource comm/volshare extend --primary-sys=<string> --primary-tag=<string> [flags]
| Flag | Short | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|---|
--primary-sys |
— | string | Yes | — | — | Hostname of the server the existing resource is extended from |
--primary-tag |
— | string | Yes | — | — | Tag of the existing resource to extend |
--standby-sys |
— | string | No | Value of --host (defaults to localhost) |
— | Hostname of the standby server |
--switchback |
— | enum | No | INTELLIGENT |
INTELLIGENT, AUTOMATIC |
Switchback type |
--primary-priority |
— | int | No | Defaults to the current priority of the --primary-sys server, or 1 if the resource has not yet been extended |
min: 1, max: 999 | Failover priority for the primary server |
--standby-priority |
— | int | No | Defaults to an unused value which is computed dynamically based on the priority values currently in-use | min: 1, max: 999 | Failover priority for the standby server |
get-property / set-property
lkcli resource comm/volshare get-property --tag=<string> --property=<string>
lkcli resource comm/volshare set-property --tag=<string> --property=<string> --value=<string>| Flag | Short | Type | Required | Description |
|---|---|---|---|---|
--tag |
-t |
string | Yes | Resource tag name |
--property |
-p |
string | Yes | Property name (see Properties table below) |
--value |
-v |
string | Yes (set-property only) |
New property value |
Properties
| Property | Type | Constraints | Editable | Description |
|---|---|---|---|---|
file-share-list |
JSON array | — | No | List of file share objects; each has file_share_name and file_share_path fields |
kit-name |
string | — | No | Recovery kit name |
deepcheck-interval |
int | min: 0, max: 604800 | Yes | Deepcheck interval in seconds (default: 300) |
quickcheck-interval |
int | min: 0, max: 604800 | Yes | Quickcheck interval in seconds (default: 180) |
local-recovery |
enum | enabled, disabled |
Yes | Enable local recovery |
switchback |
enum | INTELLIGENT, AUTOMATIC |
Yes | Switchback type |
Example Usage
# Create a File Share List resource protecting two shares
lkcli resource comm/volshare create \
--host=server1 \
--file-share-list="Data=E:\Data,Logs=E:\Logs" \
--tag=volshare.E
# Extend to server2
lkcli resource comm/volshare extend \
--primary-sys=server1 \
--primary-tag=volshare.E \
--standby-sys=server2
# Read the file share list
lkcli resource comm/volshare get-property \
--host=server1 \
--tag=volshare.E \
--property=file-share-list
Post your comment on this topic.