viocli get Command

The viocli get command supports various actions to perform different tasks. The following parameter applies to all actions:


Parameter	Mandatory or Optional	Description
-v or --verbose	Optional	Displays output in verbose mode.

To display the parameters for the command, run viocli get -h or viocli get --help. You can also use the -h or --help option to display parameters for any action. For example, viocli get controllers -h shows parameters for the controller action.

Use viocli get to perform the following actions.

`viocli get controllers [-v]`

Displays information about all controllers in your deployment. You can include the -v parameter to display the validation results of the control plane.

`viocli get deployment [-v]`

Displays detailed information about your deployment, including its overall status, the status of your log analytics integration (if configured), and the status of each node.

`viocli get drivers`

Displays driver types for OpenStack Cinder and OpenStack Neutron.

`viocli get resources`

Displays a list of all resource types in your deployment. When displaying information about a specific resource, the following additional parameters apply:


Option	Description
aodh	Get OpenStack Aodh services.
availability-zones	Get OpenStack-managed availability zones and the hosts located in them.
backup	Get backup list of your OpenStack deployment.
backupschedule	Get scheduled backup list of your OpenStack deployment.
barbican	Get OpenStack Barbican services.
ceilometer	Get OpenStack Ceilometer services
ceilometeragent	Get OpenStack Ceilometer Agent services
certificates	Get the certificates in VMware Integrated OpenStack deployment.
cinder	Get OpenStack Cinder services.
controller	Displays information about all controllers in your deployment.
deployment	Displays detailed information about your deployment, including its overall status, the status of your log analytics integration (if configured), and the status of each node.
designate	Get OpenStack designate services.
drivers	Displays different drivers for OpenStack Cinder and OpenStack Neutron.
glance	Get OpenStack Glance services.
gnocchi	Get OpenStack Gnocchi services.
heat	Get OpenStack Heat services.
horizon	Get OpenStack Horizon services.
hypervisors	Get all OpenStack-managed hypervisors with detailed information.
instances	Displays OpenStack instances with the specific state in Nova service, or vCenter.
keystone	Get OpenStack Keystone services.
managed-vms	Get OpenStack-managed vSphere virtual machines.
mariadb	Get OpenStack database services.
memcached	Get memory cache services.
neutron	Get OpenStack Neutron services.
nova	Get OpenStack Nova services.
novacompute	Get OpenStack Nova Compute services.
nsx	Get NSX object list.
octavia	Get OpenStack Octavia services.
openvswitch	Get OpenvSwitch objects list.
osdeployment	Get the names of OpenStack deployment and check that it is in a running state.
panko	Get OpenStack Panko services.
placement	Get OpenStack placement services.
rabbitmq	Get message queue services.
resources	Displays a list of all resource types in your deployment.
services	Get the OpenStack services running in the deployment, filtered by supported flags.
shadow-vms	Get all shadow virtual machines.
swift	Get Swift cluster list.
tenant-vdcs	Get tenant virtual data center (VDC) list.
time	Get nodes current time.
vCenter	Get vCenter object list.
vioingress	Get Ingress services.
viosecret	Get VMware Integrated OpenStacksecrets.
vioshim	Get the names of the viocli (vioshim) pod and container and check that it is in a running state.
vioutils	Get VMware Integrated OpenStack utility services.

`viocli get <resource-type> <resource-name>`

Displays all resources of a certain type. When displaying resources of the instances type, the following additional parameters apply:


Parameter	Mandatory or Optional	Description
--nova-state {ERROR \| SHUTOFF}	Optional	Displays OpenStack instances in the `ERROR` or `SHUTOFF` state only.
--vc-state {poweredOn \| poweredOff \| suspended}	Optional	Displays OpenStack instances in the specified state that are powered on, powered off, or suspended in vCenter Server.

viocli get resource-type resource-name

Displays information about a specific resource. When displaying information about a specific resource, the following additional parameters apply:


Parameter	Mandatory or Optional	Description
--history	Optional	Displays the configuration changes for the specified resource.

viocli get instances -h

Displays all Nova instances.

Usage:

viocli get instances [--nova-state={ERROR|SHUTOFF} --vc-state={poweredOn|poweredOff|suspended}] [flags]

Aliases:

instances, show-instances

The following flags apply to Nova instances:


Parameter		Description
-h	--help	Displays the help messages for the instances.
	--no-grace-period	Ignores the grace period when determining whether the objects are orphaned. When this parameter is set, the results show only the objects that are modified in the last thirty minutes.
	--nova-state string	Applies the action to Nova instances in `ERROR` or `SHUTOFF` state.
	--orphaned	Shows only the orphaned objects.
-o	--output string	Displays the output format. You must specify `text\|json`. Default is `text`.
-o	--vc-state string	Displays Nova instances in the specified state such as powered on, powered off, or suspended in vCenter Server. You must also use --nova state flag.
-v	--verbose	Displays output in verbose mode.

viocli get managed-vms -h

Displays all OpenStack managed vSphere virtual machines.

Usage:

viocli get managed-vms [flags]

Aliases:

managed-vms, show-instance-vms

The following flags apply to OpenStack managed vSphere virtual machines:


Parameter		Description
-h	--help	Displays the help messages for the `managed-vms`.
	--no-grace-period	Ignores the grace period when determining whether the objects are orphaned.
	--orphaned	Shows only orphaned objects. When this parameter is set, the results show only the objects that are modified in the last thirty minutes
-o	--output string	Displays the output format. You must specify `text\|json`. Default is `text`.
-v	--verbose	Displays output in verbose mode.

viocli get shadow-vms -h

Displays all shadow virtual machines.

Usage:

viocli get shadow-vms [flags]

Aliases:

 shadow-vms, show-shadow-vms

The following flags apply to shadow virtual machines:


Parameter		Description
-h	--help	Displays the help messages for the `shadow-vms`.
	--no-grace-period	Ignores the grace period when determining whether the objects are orphaned. When this parameter is set, the results show only the objects that are modified in the last thirty minutes.
	--orphaned	Shows only the orphaned objects.
-o	--output string	Displays the output format. You must specify `text\|json`. Default is `text`.
-v	--verbose	Displays output in verbose mode.