Reference For: developers, administrators

kyvernon datastore

The datastore command of the kyvernon CLI with its subcommands and arguments.

kyvernon datastore

Datastore files

Usage
kyvernon datastore <COMMAND>

Subcommands: remove, refresh, ls, mkdir, rm, orphans, cp, mv, upload, download

kyvernon datastore remove

Remove a datastore from every host and the inventory (files stay on the storage)

Usage
kyvernon datastore remove <ID>
ArgumentDescriptionRequired
<ID>Datastore idyes

API operation: DELETE /v1/datastores/{id}

kyvernon datastore refresh

Measure the size and free space of a datastore on a host that mounts it

Usage
kyvernon datastore refresh <ID>
ArgumentDescriptionRequired
<ID>Datastore idyes

API operation: POST /v1/datastores/{id}/refresh

kyvernon datastore ls

List a folder

Usage
kyvernon datastore ls <ID> [PATH]
ArgumentDescriptionRequired
<ID>Datastore idyes
<PATH>Path below the root (empty for the root)

API operation: GET /v1/datastores/{id}/files

kyvernon datastore mkdir

Create a folder (and its parents)

Usage
kyvernon datastore mkdir <ID> <PATH>
ArgumentDescriptionRequired
<ID>Datastore idyes
<PATH>Folder pathyes

API operation: POST /v1/datastores/{id}/folders

kyvernon datastore rm

Delete a file or empty folder

Usage
kyvernon datastore rm <ID> <PATH>
ArgumentDescriptionRequired
<ID>Datastore idyes
<PATH>Pathyes

API operation: DELETE /v1/datastores/{id}/files

kyvernon datastore orphans

Report disk images nothing references (no virtual machine, template or snapshot; not an overlay or backing image of a referenced disk; not a content-library file), and change-tracking sidecars whose image is gone. Report only: nothing is deleted

Usage
kyvernon datastore orphans [OPTIONS] <ID>
ArgumentDescriptionRequired
<ID>Datastore idyes
--min-age-secondsLeave out files changed within this many seconds (server default 300)

API operation: GET /v1/datastores/{id}/orphan-disks

kyvernon datastore cp

Copy a file (CopyDatastoreFile_Task)

Usage
kyvernon datastore cp [OPTIONS] <ID> <SOURCE> <DESTINATION>
ArgumentDescriptionRequired
<ID>Source datastore idyes
<SOURCE>Source path below the rootyes
<DESTINATION>Destination path below the destination datastore rootyes
--destination-datastoreDestination datastore (default: the source datastore)
--overwriteReplace an existing destination

API operation: POST /v1/datastores/{id}/files/copy

kyvernon datastore mv

Move or rename a file (MoveDatastoreFile_Task)

Usage
kyvernon datastore mv [OPTIONS] <ID> <SOURCE> <DESTINATION>
ArgumentDescriptionRequired
<ID>Source datastore idyes
<SOURCE>Source path below the rootyes
<DESTINATION>Destination path below the destination datastore rootyes
--destination-datastoreDestination datastore (default: the source datastore)
--overwriteReplace an existing destination

API operation: POST /v1/datastores/{id}/files/move

kyvernon datastore upload

Upload a local file (streamed)

Usage
kyvernon datastore upload [OPTIONS] <ID> <FILE>
ArgumentDescriptionRequired
<ID>Datastore idyes
<FILE>Local fileyes
--pathTarget path (default: the file name at the root)
--overwriteReplace an existing file

API operation: PUT /v1/datastores/{id}/files/content

kyvernon datastore download

Download a file (streamed) to a local path

Usage
kyvernon datastore download [OPTIONS] <ID> <PATH>
ArgumentDescriptionRequired
<ID>Datastore idyes
<PATH>Path on the datastoreyes
--toLocal file (default: the file name in the current directory)

API operation: GET /v1/datastores/{id}/files/content

Version 0.1.