lbavs CLI

lbavs is a CLI tool used to begin a storage workflow. Each workflow performs a specific storage management function; e.g., creating a VMFS datastore, deleting a VMFS datastore, etc.

Lightbits AVS CLI commands expect input parameters and render outputs. Two types of commands are currently supported:

• Datastore workflows
• Network workflows

Datastore Workflows

Creating a Datastore

lbavs datastore create --vmcluster vSphere-cluster-001 --name Datastore-01 --size 20GiB - -replica 3 --compression yes|no --failuredomain failureDomain

• The datastore size should be greater than 2 GiB and less than 63TiB.
• The datastore name must be unique across vCenter and vSphere clusters.
• The datastore will have a matching volume name on the Lightbits storage cluster.
• The volume will be deleted if datastore creation fails.
• A failure domain is provided either as a command parameter or configured in the lbavs.yaml file.

Deleting a Datastore

lbavs datastore delete --vmcluster vSphere-cluster-001 --name Datastore-01

• The datastore and volume will be deleted if datastore is accessible to a single cluster and not shared across vSphere clusters.
• The datastore and volume will not be deleted if the given datastore is shared across multiple vSphere clusters. Instead, the datastore will be unmounted from all ESXi hosts under the given vSphere cluster.
• The datastore and volume will not be deleted if there is any virtual machine running on the given datastore.
• The datastore in Unmounted state will not be deleted.

Mounting a Datastore

lbavs datastore mount --vmcluster vSphere-cluster-001 --name Datastore-01

• The datastore will be mounted on all ESXi hosts, under the given vSphere cluster.
• The datastore and volume must be available to the ESXi host(s) under the vSphere cluster.

Unmounting a Datastore

lbavs datastore unmount --vmcluster vSphere-cluster-001 --name Datastore-01

• The datastore will be unmounted on all ESXi hosts under the given vSphere cluster - if datastore is accessible to a single cluster and not shared across clusters.
• The datastore will be unmounted on hosts under the given vSphere clusters, but if shared, it will remain mounted to all ESXi host(s) in other vSphere clusters.
• The datastore will not be unmounted if there is any virtual machine running on the given datastore.

Rescanning a Datastore

lbavs datastore rescan --vmcluster vSphere-cluster-001

• The datastore must be rescanned (refreshed) on all ESXi hosts, under the given vSphere cluster.
• The previous datastore must disappear, and the newly created datastore must appear on each ESXi host under the given vSphere cluster.

Listing a Datastore

lbavs datastore list --vmcluster vSphere-cluster-001

• All VMFS datastores accessible to the ESXi host under the given vSphere cluster will be rendered on the screen.
• Each datastore will be printed with Info (Name, Type, Capacity, Available Space, etc.)

Resizing a Datastore

lbavs datastore resize --vmcluster vSphere-cluster-001 --name datastore-01 --newsize

10GiB

• Resize an existing VMFS datastore.
• Resize will increase the current capacity of the datastore to the provided size.
• Resize does not support reducing the current capacity.

Network Workflows

Connecting to Target(s)

lbavs network connect --vmcluster vSphere-cluster-001

• All ESXi hosts under the given vSphere cluster must be connected to Lightbits controllers over the datapath.
• Each ESXi host under the given cluster is connected to each Lightbits controller node over the datapath.

Disconnecting from Target(s)

lbavs network disconnect --vmcluster vSphere-cluster-001

• All ESXi hosts under the given vSphere cluster must be disconnected from Lightbits controllers over the datapath, except for ESXi host(s) that have at least one volume provisioned from a Lightbits cluster.
• Each ESXi host under the given cluster is disconnected from each Lightbits controller node over the datapath.
• ESXi hosts will not be disconnected if there is any datastore/volume provisioned to a host from the Lightbits cluster.

Enabling NVMe/TCP Services (tag)

lbavs network tag --vmhost 10.10.10.10 --name vmk1

• ESXi host with NVMe storage adapters is configured for NVMe/TCP services.
• NVMe/TCP enablement is supported.
• NVMe/TCP disablement is not supported for this release.

Creating a Storage Adapter

lbavs network create --vmhost 10.10.10.10 --name vmnic0

• Create a new storage adapter on the given ESXi host; adapter is bound to the given VmNIC.
• NVMe/TCP services must be enabled prior to creating a storage adapter.

Viewing all vSphere Cluster(s)

lbavs vsphere list

• View all vSphere cluster(s) in the Azure AVS environment.

Datastore Snapshot

Create a Snapshot

lbavs snapshot create --name snapshot-name --source datastore-name --retention 10[d]

[D]

• Create a new snapshot of the provided datastore name.
• Source datastore must be in Available state at the time of snapshot creation.
• All input parameters are mandatory. Retention duration is accepted in days.
• Successful operation creates a snapshot of the volume on the Lightbits storage cluster.
• This command also creates snapshots of all healthy VMs of the provided source datastore.

List Snapshot

lbavs snapshot list

• View all available datastore snapshots in the environment.
• Each snapshot (Name, State, Size, Source Datastore, Retention Time) related information is printed.