lsva command

Use the lsva command to list virtual appliances.

Synopsis

smcli [-c] [-prompt] [-user user_name] [-pw password] lsva options

For information about the options listed above that are specific to smcli, enter smcli -?.

smcli lsva [-h | -? | --help]

smcli lsva [-v] [-l] [-o] [-q query_expression] [-Q query_name] [-d delimiter_symbol]

Description

The lsva command displays a list of virtual appliances. The results that are returned depend on the options that are specified.

Options

-d | --delimiter "delimiter_symbol"

Specifies the character or set of characters that separates output data, where delimiter_symbol is a string of one or more characters. This command separates data fields in a record by a comma followed by a space. Data records are separated by the specified delimiter delimiter_symbol.

If you specify this option with the -l | --long option, the delimiter option is ignored.

Tip: If the delimiter contains spaces, enclose it in quotation marks.

-h | -?

Displays the syntax and a brief description of the command.

Tip: If you specify additional options, the options are ignored.

--help

Displays detailed information about the command, including the syntax, a description of the command, a description of the options and operands, error codes, and examples.

Tips:

If you specify additional options, the options are ignored.
(AIX® and Linux only) You can also display detailed help in the form of man pages using the man command_name command.

-l | --long

Displays all attributes of the specified object.

-o | --oid

Displays the unique IDs (OIDs), in addition to other information, associated with the targeted object.

The unique IDs are displayed as decimal values (for example, 123).

Note: You can combine this option with the -l | --long option.

-q | --query query_expression

Searches for virtual appliances and displays results based on advanced search parameters that you input. Each query expression is in the format (property operand relational_expression). The query expressions can be nested to generate more complex queries. The following parameters are supported.

Properties:

name
date
user
description
appliance
revision
trunk
tags
repository
os

Note: "repository" represents the display name of the repository object in the database. "os" represents the name of the operating system defined in the OVF descriptor file.

Operands:

=
<
>
<=
>=
equals
starts-with
ends-with
contains

Relational expressions:

Date format: YYYY-MM-DD

Query examples:

((trunk = VA1) AND (revision >= 1.1.2.1))
(((trunk = VA1) OR (date > 2009-10-12)) AND (name contains H))

Note: The -q | –query option cannot be combined with the -Q | –qname option.

-Q | --qname query_name

Searches for virtual appliances and displays results based on an existing query specified by the query name. The query can be defined using the mkvaquery command.

Tip: If the query name contains spaces, enclose it in quotation marks.

Note: The -Q | –qname option cannot be combined with the -q | –query option.

-v | --verbose

Writes verbose messages to standard output.

If this option is not specified, this command suppresses noncritical messages.

Exit status

The following codes are returned by this command.

0: The operation completed.
1: A usage error occurred.
2: The command or bundle was not found.
3: The command was not performed because either authentication failed or you are not authorized to perform the action.
9: An invalid locale was used.
27: An invalid attribute was specified.
29: The specified locale is not valid or not supported.
69: An invalid virtual appliance criteria was fetched.
87: An invalid query was used.
125: The command terminated.

Examples

Display all virtual appliances
This example illustrates how to display a list of all virtual appliances.
```
smcli lsva -v
```
Display all virtual appliances and OIDs
This example illustrates how to display a list of all virtual appliances and their unique IDs.
```
smcli lsva -v -o
```
Display all virtual appliances according to a search query
This example illustrates how to display a list of all virtual appliances that have a trunk value of 1.1 and a revision value that is 1.1.2.1 or greater.
```
smcli lsva -q "((trunk = 1.1) AND (revision >= 1.1.2.1))"
```
Display all virtual appliances according to an existing search query
This example illustrates how to display a list of all virtual appliances according to an existing named search query named "my query".
```
smcli lsva -Q "my query"
```