kyvernon host

`kyvernon host`

Host operations

Usage

kyvernon host <COMMAND>

Subcommands: enter-maintenance, exit-maintenance, destroy, disconnect, reconnect, join-token, reboot, shutdown, iscsi, mount-datastore, unmount-datastore, create-datastore, remove-datastore, vmfs-disks, vmfs-create-options, network-hints, network-health, set-software-iscsi, set-iscsi-auth, add-iscsi-send-targets, remove-iscsi-send-targets, add-iscsi-static-targets, remove-iscsi-static-targets, rescan-iscsi, rescan-all-iscsi

`kyvernon host enter-maintenance`

Enter maintenance mode

Usage

kyvernon host enter-maintenance [OPTIONS] <ID>

Argument	Description	Required
`<ID>`	Host id	yes
`--wait`	Wait for the task

API operation: POST /v1/hosts/{id}/enter-maintenance

`kyvernon host exit-maintenance`

Exit maintenance mode

Usage

kyvernon host exit-maintenance [OPTIONS] <ID>

Argument	Description	Required
`<ID>`	Host id	yes
`--wait`	Wait for the task

API operation: POST /v1/hosts/{id}/exit-maintenance

`kyvernon host destroy`

Remove a host with no VMs placed on it

Usage

kyvernon host destroy [OPTIONS] <ID>

Argument	Description	Required
`<ID>`	Host id	yes
`--wait`	Wait for the task

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

`kyvernon host disconnect`

Disconnect a host (sticky until reconnect)

Usage

kyvernon host disconnect [OPTIONS] <ID>

Argument	Description	Required
`<ID>`	Host id	yes
`--wait`	Wait for the task

API operation: POST /v1/hosts/{id}/disconnect

`kyvernon host reconnect`

Reconnect a previously disconnected host

Usage

kyvernon host reconnect [OPTIONS] <ID>

Argument	Description	Required
`<ID>`	Host id	yes
`--wait`	Wait for the task

API operation: POST /v1/hosts/{id}/reconnect

`kyvernon host join-token`

The join token and controller endpoint a new host needs

Usage

kyvernon host join-token

API operation: GET /v1/hosts/join-token

`kyvernon host reboot`

Reboot a host (in maintenance mode, or with --force)

Usage

kyvernon host reboot [OPTIONS] <ID>

Argument	Description	Required
`<ID>`	Host id	yes
`--force`	Reboot although the host is not in maintenance mode
`--wait`	Wait for the task

API operation: POST /v1/hosts/{id}/reboot

`kyvernon host shutdown`

Shut a host down (in maintenance mode, or with --force)

Usage

kyvernon host shutdown [OPTIONS] <ID>

Argument	Description	Required
`<ID>`	Host id	yes
`--force`	Shut down although the host is not in maintenance mode
`--wait`	Wait for the task

API operation: POST /v1/hosts/{id}/shutdown

`kyvernon host iscsi`

Show the software iSCSI configuration of a host

Usage

kyvernon host iscsi <ID>

Argument	Description	Required
`<ID>`	Host id	yes

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

`kyvernon host mount-datastore`

Mount an NFS datastore on one more host (or again after an unmount)

Usage

kyvernon host mount-datastore <ID> <DS_ID>

Argument	Description	Required
`<ID>`	Host id	yes
`<DS_ID>`	Datastore id	yes

API operation: POST /v1/hosts/{id}/datastores/{dsId}/mount

`kyvernon host unmount-datastore`

Unmount a datastore on one host; the datastore and its files stay

Usage

kyvernon host unmount-datastore <ID> <DS_ID>

Argument	Description	Required
`<ID>`	Host id	yes
`<DS_ID>`	Datastore id	yes

API operation: POST /v1/hosts/{id}/datastores/{dsId}/unmount

`kyvernon host create-datastore`

Create a local, NFS, or VMFS datastore on a host (CreateLocalDatastore / CreateNasDatastore / CreateVmfsDatastore)

Usage

kyvernon host create-datastore [OPTIONS] <ID>

Argument	Description	Required
`<ID>`	Host id	yes
`--type`	`local`, `nfs`, or `vmfs`	yes
`--name`	Datastore name	yes
`--path`	Absolute host path (local)
`--remote-host`	NFS server
`--remote-path`	NFS export path
`--access-mode`	`readWrite` or `readOnly`
`--nfs-type`	`NFS` or `NFS41`
`--security-type`	NFS security flavour
`--disk`	Disk key for VMFS: WWID, `naa.…`, or device path

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

`kyvernon host remove-datastore`

Remove a datastore from a host (RemoveDatastore)

Usage

kyvernon host remove-datastore <ID> <DS_ID>

Argument	Description	Required
`<ID>`	Host id	yes
`<DS_ID>`	Datastore id (`datastore-N`)	yes

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

`kyvernon host vmfs-disks`

List iSCSI LUNs available for VMFS create (QueryAvailableDisksForVmfs)

Usage

kyvernon host vmfs-disks <ID>

Argument	Description	Required
`<ID>`	Host id	yes

API operation: GET /v1/hosts/{id}/vmfs-disks

`kyvernon host vmfs-create-options`

Query VMFS create options for a disk (QueryVmfsDatastoreCreateOptions)

Usage

kyvernon host vmfs-create-options [OPTIONS] <ID>

Argument	Description	Required
`<ID>`	Host id	yes
`--device-path`	Device path, WWID, or `naa.…`	yes

API operation: GET /v1/hosts/{id}/vmfs-create-options

`kyvernon host network-hints`

List LLDP/CDP neighbours (HostNetworkSystem.QueryNetworkHint)

Usage

kyvernon host network-hints [OPTIONS] <ID>

Argument	Description	Required
`<ID>`	Host id	yes
`--device`	Optional physical NIC device name (repeatable)

API operation: GET /v1/hosts/{id}/network-hints

`kyvernon host network-health`

Host-bridge VLAN/MTU realisation health (ESX-N-17)

Usage

kyvernon host network-health <ID>

Argument	Description	Required
`<ID>`	Host id	yes

API operation: GET /v1/hosts/{id}/network-health

`kyvernon host set-software-iscsi`

Enable or disable software iSCSI (UpdateSoftwareInternetScsiEnabled)

Usage

kyvernon host set-software-iscsi [OPTIONS] <ID>

Argument	Description	Required
`<ID>`	Host id	yes
`--enabled`	Enable software iSCSI
`--disabled`	Disable software iSCSI

API operation: PUT /v1/hosts/{id}/iscsi/software

`kyvernon host set-iscsi-auth`

Set adapter-level iSCSI CHAP (UpdateInternetScsiAuthenticationProperties)

Usage

kyvernon host set-iscsi-auth [OPTIONS] <ID>

Argument	Description	Required
`<ID>`	Host id	yes
`--chap-enabled`	Enable CHAP
`--chap-disabled`	Disable CHAP (clears adapter CHAP)
`--chap-name`	CHAP user name
`--chap-secret`	CHAP secret
`--mutual-chap-name`	Mutual CHAP user name
`--mutual-chap-secret`	Mutual CHAP secret

API operation: PUT /v1/hosts/{id}/iscsi/authentication

`kyvernon host add-iscsi-send-targets`

Add iSCSI send targets (AddInternetScsiSendTargets)

Usage

kyvernon host add-iscsi-send-targets [OPTIONS] <ID>

Argument	Description	Required
`<ID>`	Host id	yes
`--address`	Portal address	yes
`--port`	Portal TCP port

API operation: POST /v1/hosts/{id}/iscsi/send-targets

`kyvernon host remove-iscsi-send-targets`

Remove iSCSI send targets (RemoveInternetScsiSendTargets)

Usage

kyvernon host remove-iscsi-send-targets [OPTIONS] <ID>

Argument	Description	Required
`<ID>`	Host id	yes
`--address`	Portal address	yes
`--port`	Portal TCP port

API operation: DELETE /v1/hosts/{id}/iscsi/send-targets

`kyvernon host add-iscsi-static-targets`

Add iSCSI static targets (AddInternetScsiStaticTargets)

Usage

kyvernon host add-iscsi-static-targets [OPTIONS] <ID>

Argument	Description	Required
`<ID>`	Host id	yes
`--address`	Portal address	yes
`--iqn`	Target IQN	yes
`--port`	Portal TCP port

API operation: POST /v1/hosts/{id}/iscsi/static-targets

`kyvernon host remove-iscsi-static-targets`

Remove iSCSI static targets (RemoveInternetScsiStaticTargets)

Usage

kyvernon host remove-iscsi-static-targets [OPTIONS] <ID>

Argument	Description	Required
`<ID>`	Host id	yes
`--address`	Portal address	yes
`--iqn`	Target IQN	yes
`--port`	Portal TCP port

API operation: DELETE /v1/hosts/{id}/iscsi/static-targets

`kyvernon host rescan-iscsi`

Rescan one software iSCSI HBA (RescanHba)

Usage

kyvernon host rescan-iscsi [OPTIONS] <ID>

Argument	Description	Required
`<ID>`	Host id	yes
`--hba-device`	HBA device (default `vmhba64`)

API operation: POST /v1/hosts/{id}/iscsi/rescan

`kyvernon host rescan-all-iscsi`

Rescan every projected HBA (RescanAllHba)

Usage

kyvernon host rescan-all-iscsi <ID>

Argument	Description	Required
`<ID>`	Host id	yes

API operation: POST /v1/hosts/{id}/iscsi/rescan-all