Page Comparison

Introduction

One of the most powerful options in the ITS Private Cloud Command-Line interface (vss-cli) is the --columns global option. This option allows to show/hide any object attribute to customize the output of the vss-cli.

...

The above command works for other objects such as:

...

...

Example: List Virtual Machines disks and networks (compute vm ls)

In this example we need to get a list of virtual machines with the following attributes:

...

1. Run the following command to obtain the equivalent attributes:

   Code Block
   vss-cli --output yaml compute vm ls -c 1

2. Then identify object defined attribute disks and networks and their sub-attributes to require. In this case disks.label, disks.capacity_gib and networks.name.

3. Use jsonpath to extract the proper values:

   1. disks[*].capacity_gib

   2. disks[*].label

   3. networks[*].name

4. Join the columns in and add them to the --columns option as follows.

   Code Block
   vss-cli --columns moref,name,Folder=folder.path,"Disk Capacity=disks[*].capacity_gib,Disk Labels=disks[*].label,networks[*].name" compute vm ls

5. An example result would be as follows:

   Code Block
   moref name Folder Disk Capacity Disk Labels networks[*].name --------- -------------------------- -------------------- --------------- ------------------------ ------------------- vm-123455 2406Q-app-10-no-storage-qa Public > Client > QA 150.0, 100.0 Hard disk 2, Hard disk 1 VL-0253-EIS-VSS-CGN

...

Example: List Virtual Machines disks and networks (compute vm ls) and filter by folder path

In addition to the previous example, you can add the local --filter-by option to the ls command, in this case, to the vss-cli compute vm ls. Filtering with the vss-cli has the following format: <field_name>=<operator>,<value>. Where operator is any of the following:

• like: default value. Matches value as substring.

• eq: equal, or exact value.

• ne: non-equal to value.

• lt: lower than value.

• le: lower or equal value.

• gt: greater than value.

• ge: greater and equal to value.

• in: in multiple values.

...

1. Filtering works on any object attribute, in case of virtual machines, you can show available attributes to filter with:

   Code Block
   vss-cli --output yaml compute vm ls -c 1

2. Based on the previous output, folder path is an attribute of folder, thus it will be accessible using folder.path in the --filter-by option as follows:

   Code Block
   vss-cli --columns moref,name,Folder=folder.path,"Disk Capacity=disks[*].capacity_gib,Disk Labels=disks[*].label,networks[*].name" \ compute vm ls -f folder.path="Public > Client > QA"

Example: List Virtual Machines disks and networks (compute vm ls) and filter by multiple names

Filtering by multiple values is also possible with the --filter-by/-f option added to the ls command, in this case, to the vss-cli compute vm ls. Filtering with the vss-cli has the following format: <field_name>=<operator>,<value>. Where operator is any of the following:

• like: default value. Matches value as substring.

• eq: equal, or exact value.

• ne: non-equal to value.

• lt: lower than value.

• le: lower or equal value.

• gt: greater than value.

• ge: greater and equal to value.

• in: in multiple values. *

Now that we know the --filter-by/-f syntax and the possible operators, let's get on to the example.

In this case, we need to filter by multiple names, and first we have to get the right attribute name.

1. Filtering works on any object attribute, in case of virtual machines, you can show available attributes to filter with:

   Code Block
   vss-cli --output yaml compute vm ls -c 1

2. Based on the previous output, name is the attribute to use, along with the in operator as follows:

   Code Block
   vss-cli --columns moref,name,Folder=folder.path,"Disk Capacity=disks[*].capacity_gib,Disk Labels=disks[*].label,networks[*].name" \ compute vm ls --filter-by "name=in,2407P-name1,2407P-name2"

\uD83D\uDCCB Related articles