kyvernon inventory

`kyvernon inventory`

Inventory

Usage

kyvernon inventory <COMMAND>

Subcommands: roots, children, path, vms, hosts, datastores, networks, get, vm, host, datastore, network, datacenter, cluster, search, kind, create, update, delete, move-into, move-into-pool, changes, rename, create-datacenter, delete-datacenter, tag-categories, tags, object-tags

`kyvernon inventory roots`

Top-level nodes

Usage

kyvernon inventory roots

API operation: GET /v1/inventory/roots

`kyvernon inventory children`

Children of a node

Usage

kyvernon inventory children <ID>

Argument	Description	Required
`<ID>`	Node id	yes

API operation: GET /v1/inventory/nodes/{id}/children

`kyvernon inventory path`

Path to a node

Usage

kyvernon inventory path <ID>

Argument	Description	Required
`<ID>`	Node id	yes

API operation: GET /v1/inventory/nodes/{id}/path

`kyvernon inventory vms`

Virtual machines

Usage

kyvernon inventory vms [OPTIONS]

Argument	Description	Required
`--scope`	Container id (datacenter, folder, cluster, host, pool, datastore, network)
`--limit`	Maximum items
`--after`	Resume after this id

API operation: GET /v1/inventory/vms

`kyvernon inventory hosts`

Hosts

Usage

kyvernon inventory hosts [OPTIONS]

Argument	Description	Required
`--scope`	Container id (datacenter, folder, cluster, host, pool, datastore, network)
`--limit`	Maximum items
`--after`	Resume after this id

API operation: GET /v1/inventory/hosts

`kyvernon inventory datastores`

Datastores

Usage

kyvernon inventory datastores [OPTIONS]

Argument	Description	Required
`--scope`	Container id (datacenter, folder, cluster, host, pool, datastore, network)
`--limit`	Maximum items
`--after`	Resume after this id

API operation: GET /v1/inventory/datastores

`kyvernon inventory networks`

Networks

Usage

kyvernon inventory networks [OPTIONS]

Argument	Description	Required
`--scope`	Container id (datacenter, folder, cluster, host, pool, datastore, network)
`--limit`	Maximum items
`--after`	Resume after this id

API operation: GET /v1/inventory/networks

`kyvernon inventory get`

Any object by id

Usage

kyvernon inventory get <ID>

Argument	Description	Required
`<ID>`	Object id	yes

API operation: GET /v1/inventory/objects/{id}

`kyvernon inventory vm`

A virtual machine by id

Usage

kyvernon inventory vm <ID>

Argument	Description	Required
`<ID>`	`vm-N`	yes

API operation: GET /v1/inventory/vms/{id}

`kyvernon inventory host`

A host by id

Usage

kyvernon inventory host <ID>

Argument	Description	Required
`<ID>`	`host-N`	yes

API operation: GET /v1/inventory/hosts/{id}

`kyvernon inventory datastore`

A datastore by id

Usage

kyvernon inventory datastore <ID>

Argument	Description	Required
`<ID>`	`datastore-N`	yes

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

`kyvernon inventory network`

A network by id

Usage

kyvernon inventory network <ID>

Argument	Description	Required
`<ID>`	`network-N` or `dvportgroup-N`	yes

API operation: GET /v1/inventory/networks/{id}

`kyvernon inventory datacenter`

A datacenter by id

Usage

kyvernon inventory datacenter <ID>

Argument	Description	Required
`<ID>`	`datacenter-N`	yes

API operation: GET /v1/inventory/datacenters/{id}

`kyvernon inventory cluster`

A cluster by id

Usage

kyvernon inventory cluster <ID>

Argument	Description	Required
`<ID>`	`domain-cN`	yes

API operation: GET /v1/inventory/clusters/{id}

`kyvernon inventory search`

Name search

Usage

kyvernon inventory search [OPTIONS] <Q>

Argument	Description	Required
`<Q>`	Substring	yes
`--limit`	Maximum items

API operation: GET /v1/inventory/search

`kyvernon inventory kind`

Records of one kind (virtual_machine, vm_folder, tag, ...)

Usage

kyvernon inventory kind [OPTIONS] <KIND>

Argument	Description	Required
`<KIND>`	Kind name	yes
`--parent`	Only children of this parent
`--name-prefix`	Name prefix
`--changed-after`	Only records changed after this store version
`--limit`	Maximum items
`--after`	Resume after this id (from `next`)

API operation: GET /v1/inventory/kinds/{kind}

`kyvernon inventory create`

Create a record of a kind from a JSON body

Usage

kyvernon inventory create [OPTIONS] <KIND>

Argument	Description	Required
`<KIND>`	Kind name	yes
`--parent`	Parent id
`--body`	Inline JSON body
`--body-file`	File with the JSON body (`-` for stdin)

API operation: POST /v1/inventory/kinds/{kind}

`kyvernon inventory update`

Replace a record body (compare-and-set)

Usage

kyvernon inventory update [OPTIONS] <ID>

Argument	Description	Required
`<ID>`	Object id	yes
`--expected-version`	Version read before the change	yes
`--body`	Inline JSON body
`--body-file`	File with the JSON body (`-` for stdin)

API operation: PUT /v1/inventory/objects/{id}

`kyvernon inventory delete`

Delete a record

Usage

kyvernon inventory delete [OPTIONS] <ID>

Argument	Description	Required
`<ID>`	Object id	yes
`--expected-version`	Fail if the version changed
`--cascade`	Also delete descendants

API operation: DELETE /v1/inventory/objects/{id}

`kyvernon inventory move-into`

Move entities into a folder (Folder.MoveIntoFolder_Task)

Usage

kyvernon inventory move-into [OPTIONS] <ID>

Argument	Description	Required
`<ID>`	Destination folder id (`group-vN`, …)	yes
`--entity`	Entities to move (repeatable)	yes
`--wait`	Wait for the task to finish and print it
`--idempotency-key`	Idempotency key (a retry with the same key returns the same task)

API operation: POST /v1/inventory/folders/{id}/move-into

`kyvernon inventory move-into-pool`

Move VMs and/or child pools into a resource pool (MoveIntoResourcePool)

Usage

kyvernon inventory move-into-pool [OPTIONS] <ID>

Argument	Description	Required
`<ID>`	Destination resource pool id (`resgroup-N`, …)	yes
`--entity`	Entities to move (repeatable)	yes
`--wait`	Wait for the task to finish and print it
`--idempotency-key`	Idempotency key (a retry with the same key returns the same task)

API operation: POST /v1/resource-pools/{id}/move-into

`kyvernon inventory changes`

Change feed (long poll)

Usage

kyvernon inventory changes [OPTIONS]

Argument	Description	Required
`--since`	Store version to start after	yes
`--timeout`	Seconds to wait for a change
`--kinds`	Comma-separated kinds
`--limit`	Maximum change sets

API operation: GET /v1/inventory/changes

`kyvernon inventory rename`

Rename an object (datacenter, folder, cluster, host, resource group, VM, datastore, network)

Usage

kyvernon inventory rename [OPTIONS] <ID> <NAME>

Argument	Description	Required
`<ID>`	Object id	yes
`<NAME>`	New name	yes
`--wait`	Wait for the task

API operation: POST /v1/inventory/objects/{id}/rename

`kyvernon inventory create-datacenter`

Create a datacenter with its folders

Usage

kyvernon inventory create-datacenter [OPTIONS] <NAME>

Argument	Description	Required
`<NAME>`	Name	yes
`--folder`	Datacenter folder (default: the root folder)

API operation: POST /v1/datacenters

`kyvernon inventory delete-datacenter`

Delete an empty datacenter

Usage

kyvernon inventory delete-datacenter <ID>

Argument	Description	Required
`<ID>`	Datacenter id	yes

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

`kyvernon inventory tag-categories`

Tag categories

Usage

kyvernon inventory tag-categories <COMMAND>

Subcommands: list, get, create, update, delete

`kyvernon inventory tag-categories list`

List categories

Usage

kyvernon inventory tag-categories list

API operation: GET /v1/tag-categories

`kyvernon inventory tag-categories get`

One category

Usage

kyvernon inventory tag-categories get <ID>

Argument	Description	Required
`<ID>`	Category id	yes

API operation: GET /v1/tag-categories/{id}

`kyvernon inventory tag-categories create`

Create a category

Usage

kyvernon inventory tag-categories create [OPTIONS] <NAME>

Argument	Description	Required
`<NAME>`	Name	yes
`--description`	Description
`--cardinality`	`single` (default) or `multiple`
`--kind`	Object kind the tags may be attached to (repeat; none: every kind)

API operation: POST /v1/tag-categories

`kyvernon inventory tag-categories update`

Change a category

Usage

kyvernon inventory tag-categories update [OPTIONS] <ID>

Argument	Description	Required
`<ID>`	Category id	yes
`--name`	New name
`--description`	New description
`--cardinality`	`multiple`
`--kind`	The new list of associable kinds (repeat; a superset of the current one)

API operation: PUT /v1/tag-categories/{id}

`kyvernon inventory tag-categories delete`

Delete a category and its tags

Usage

kyvernon inventory tag-categories delete <ID>

Argument	Description	Required
`<ID>`	Category id	yes

API operation: DELETE /v1/tag-categories/{id}

`kyvernon inventory tags`

Tags and their assignments

Usage

kyvernon inventory tags <COMMAND>

Subcommands: list, get, create, update, delete, objects, attach, detach

`kyvernon inventory tags list`

List tags

Usage

kyvernon inventory tags list [OPTIONS]

Argument	Description	Required
`--category`	Only tags of this category

API operation: GET /v1/tags

`kyvernon inventory tags get`

One tag

Usage

kyvernon inventory tags get <ID>

Argument	Description	Required
`<ID>`	Tag id	yes

API operation: GET /v1/tags/{id}

`kyvernon inventory tags create`

Create a tag

Usage

kyvernon inventory tags create [OPTIONS] <CATEGORY> <NAME>

Argument	Description	Required
`<CATEGORY>`	Category id	yes
`<NAME>`	Name	yes
`--description`	Description

API operation: POST /v1/tags

`kyvernon inventory tags update`

Change a tag

Usage

kyvernon inventory tags update [OPTIONS] <ID>

Argument	Description	Required
`<ID>`	Tag id	yes
`--name`	New name
`--description`	New description

API operation: PUT /v1/tags/{id}

`kyvernon inventory tags delete`

Delete a tag

Usage

kyvernon inventory tags delete <ID>

Argument	Description	Required
`<ID>`	Tag id	yes

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

`kyvernon inventory tags objects`

The objects a tag is attached to

Usage

kyvernon inventory tags objects <ID>

Argument	Description	Required
`<ID>`	Tag id	yes

API operation: GET /v1/tags/{id}/objects

`kyvernon inventory tags attach`

Attach a tag to objects

Usage

kyvernon inventory tags attach <ID> <OBJECTS>

Argument	Description	Required
`<ID>`	Tag id	yes
`<OBJECTS>`	Object ids	yes

API operation: POST /v1/tags/{id}/attach

`kyvernon inventory tags detach`

Detach a tag from objects

Usage

kyvernon inventory tags detach <ID> <OBJECTS>

Argument	Description	Required
`<ID>`	Tag id	yes
`<OBJECTS>`	Object ids	yes

API operation: POST /v1/tags/{id}/detach

`kyvernon inventory object-tags`

The tags attached to an object

Usage

kyvernon inventory object-tags <ID>

Argument	Description	Required
`<ID>`	Object id	yes

API operation: GET /v1/inventory/objects/{id}/tags