bconsole Query Commands

The Bacula Enterprise Nutanix-AHV Plugin supports also the query parameter. Bacula queries the Nutanix-AHV API and receives answers in the form of key=value. The Nutanix-AHV Plugin supports three query parameters. When none of them is specified, the message: Query not recognized possible value = {CONNECTION, MACHINES, NETWORK} is displayed.

Connection

This query sends a REST API request to check whether the current plugin parameters allow connections to the Nutanix-AHV server. The example below shows the execution of a correctly formatted CONNECTION query and response.

When the query parameter is CONNECTION, the returned value will be either OK or NOK, indicating whether the connection was successful or not.

.query plugin="nutanix-ahv: user=admin host=1.2.3.4" client=client-fd parameter=CONNECTION
CONNECTION=OK

VM

This query sends a REST API request that lists all available guest VMs and their respective UUID. This query displays two key=value tuples per virtual machine the first where key is VM and value is the name of the virtual machine, the second where key is UUID and value is the virtual machine’s UUID.

The example below shows the execution of a correctly formatted VM query that finds three different guest VMs.

.query plugin="nutanix-ahv: user=admin host=1.2.3.4" client=client-fd parameter=VM
VM=Virtual1
UUID=87654321-1234-5678-9abc-defghijklmno
VM=Virtual2
UUID=12345678-abcd-dcba-1234-abcdefghijkl
VM=Virtual3
UUID=11111111-2222-aaaa-bbbb-12ab12ab12ab

Network

This query sends a REST API request that lists all available networks. This query displays one key=value tuple per network available where key is NETWORK and value is the network’s name.

The example below show values output by a correctly formatted NETWORK query that finds two networks.

.query plugin="nutanix-ahv: user=admin host=1.2.3.4" client=client-fd parameter=NETWORK
NETWORK=Managed
NETWORK=Vlan-Nutanix

Protection domain

This query sends a REST API request that lists all available protection domains. This query displays protection domains names and the virtual machine included in each domain. This display starts with one key=value tuple for the protection domain name followed by zero or more key=value tuples one for each vritual machine inside the protection domain.

The example below shows the execution of a correctly formatted PROTECTION_DOMAIN query that finds

.query plugin="nutanix-ahv: user=admin host=1.2.3.4" client=client-fd parameter=PROTECTION_DOMAIN
PROTECTION_DOMAIN=pDomain
VM=Virtual1
PROTECTION_DOMAIN=emptyPDom
PROTECTION_DOMAIN=pDomain01
VM=Virtual2
VM=Virtual3

Go back to the main Operations page.

Go back to the main Nutanix-AHV page.