man(1) page: cloudscheduler vm list¶
- NAME
- cloudscheduler vm list - list VMs on cloudscheduler version 2 (csv2) servers
- SYNOPSIS
- cloudscheduler vm list [ options …]
- DESCRIPTION
- The cloudscheduler vm list action displays VMs from the current group on csv2 servers. This action is available to any user, provided they are in the group that the VMs belong to.
- OPTIONS
- Optional
The following are optional parameters:
- -cn cloud, --cloud-name cloud
- The name of a cloud definition that exists on the csv2 server. Filters the VM list to only VMs that are running on cloud.
- -vc cores, --vm-cores cores
- The number of cores the VM is allocated. Filter the VM list to only VMs with cores. cores must be an integer.
- -vd disk, --vm-disk disk
- The number of GBs of disk the VM is allocated. Filters the VM list to only VMs with disk. disk must be a number.
- -vF option, --vm-foreign option
- If the VM is foreign (not controlled by the csv2 server). The value of option must be 1 or 0 .
- -vf flavor, --vm-flavor flavor
- The name of the flavor the VM is running. Filters the VM list to only VMs with flavor.
- -vh hosts, --vm-hosts hosts
- Is a list of one or more comma seperated hostsnames used to filter the selection VMs.
- -vr ram, --vm-ram ram
- The number of MBs of ram the VM is allocated. Filters the VM list to only VMs with ram. ram must be a number.
- -vS status, --vm-status status
- The status of the VM. Filters the VM list to only VMs with sta- tus. The value of status must be one of: foreign, manual, error, unregistered, retiring, running, or other.
- -vs swap, --vm-swap swap
- The number of GBs of swap the VM is allocated. Filters the VM list to only VMs with swap. swap must be a number.
- Table
These options change the format of the displayed table(s):
-CSV column1 [,column2,… columnN], --comma-separated-values col- umn1 [,column2,… columnN]
Requests that a list of comma separated values be displayed instead of tabular output. Only the specified columns will be displayed from the current view (see --view ). To display all columns from the current view, specify a null string, ie. “–comma-separated-values ‘’”.- -CSEP separator, --comma-separated-values-separator separator
- Specifies the column separator character to be used by the -CSV parameter when printing the result. By default, a comma (“,”) is used.
- -NV , --no-view
- Ignores any defined view (see --view ) for this invocation of the command. All columns present in the list will be displayed.
- -ok , --only-keys
- Only displays the values of the keys in this list. No other columns are displayed.
- -r , --rotate
- Rotate the listed table to only have a Key and a Value column. Used to improve readability of tables with many columns.
-V column1 [,column2,… columnN], --view column1 [,column2,… columnN]
Specifies a comma-seperated list of table column names which are to be displayed. All other columns will be ignored. For a command that produces multiple result tables, the column name list for each table is separated by a slash (/ ). Using this parameter defines a “view” for this and all subsequent invocations of this command; the same column selections will be displayed until the “view” is redefined by the --view option. To remove a view, specify a null string, ie. “–with ‘’”, in which case, all defined columns will be displayed. To see which tables and columns that can be displayed, use the --view-columns option.
Default: None.
- -VC , --view-columns
- View all table and column names associated with this command. For each table of information returned by the command, a table number, table name, a possible “optional” designation, the “key” column (those that are displayed at the beginning of every segment) names, and all remaining column names are displayed. This information is useful when creating views (see --view ) or when selecting columns for comma separated output (see --comma-sepa- rated-values ).
-w table1 [,table2,… tableN], --with table1 [,table2,… tableN]
Specifies a comma-seperated list of names of optional tables to be displayed. Some commands provide additional information which are not displayed unless specifically requested by name. To determine the information returned by any particular command, use the --view-columns ( -VC ) option which provides a list of table numbers, tables names, and columns, high-lighting optional information. This option accepts table numbers as well as tables names and the special value of ALL which will display all optional information.
Default: None.
- Global
These options are avaliable on all actions:.so ../man/parameters/_group.so
- -H , --long-help
- Requests the man page style help for the current command. Long help can be requested for the cloudscheduler command, a specific object, or a specific object/action.
- -h , --help
- Requests short help for the current command. Help can be requested for the cloudscheduler command, a specific object, or a specific object/action.
- -s server, --server server
- The name of the target server. There must be an entry in the cloudscheduler defaults that matches server and it must have an authentication method.
- -v , --version
- Requests that the versions of both the CLI client and the targeted server be printed in addition to any other command output.
- -xA , --expose-API
- Requests trace messages detailing the API calls and responses issued and received by the cloudscheduler command.
- EXAMPLES
List all vms in the current group: $ cloudscheduler vm list Server: default, Active User: example, Active Group: example, User’s Groups: [‘example’, ‘testing’]
VMs: (1/5)
Group Cloud Hostname VMID Authorization URL Project Status Flavor ID example example example example example–example–vm-1 example–example–vm-2 vm-1 vm-2 example.com example.com example example 1 5 1 1 VMs: (2/5)
Group Cloud Hostname Task Power Status Terminate Terminate Time example example example example example–example–vm-1 example–example–vm-2 1 2 1 1 0 0 None None VMs: (3/5)
Group Cloud Hostname Status Change Time Last Updated Flavor Condor Slots example example example example example–example–vm-1 example–example–vm-2 2018-08-23 00:00:00 2018-08-23 00:00:00 2018-08-23 00:00:00 2018-08-23 00:00:00 s8 s8 None None VMs: (4/5)
Group Cloud Hostname Foreign cores Disk (GBs) Ram (MBs) Swap (GBs) example example example example example–example–vm-1 example–example–vm-2 0 0 1 1 5 5 1000 1000 0 0 VMs: (5/5)
Group Cloud Hostname Poller Status Manual_Control example example example example example–example–vm-1 example–example–vm-2 running error 0 0 Rows: 2
List only vms in the cloud “example” that are running: $ cloudscheduler vm list -cn example -vS running Server: default, Active User: example, Active Group: example, User’s Groups: [‘example’, ‘testing’]
VMs: (1/5)
Group Cloud Hostname VMID Authorization URL Project Status Flavor ID example example example–example–vm-1 vm-1 example.com example 1 1 VMs: (2/5)
Group Cloud Hostname Task Power Status Terminate Terminate Time example example example–example–vm-1 1 1 0 None VMs: (3/5)
Group Cloud Hostname Status Change Time Last Updated Flavor Condor Slots example example example–example–vm-1 2018-08-23 00:00:00 2018-08-23 00:00:00 s8 None VMs: (4/5)
Group Cloud Hostname Foreign cores Disk (GBs) Ram (MBs) Swap (GBs) example example example–example–vm-1 0 1 5 1000 0 VMs: (5/5)
Group Cloud Hostname Poller Status Manual_Control example example example–example–vm-1 running 0 Rows: 1
- SEE ALSO
- csv2 (1) csv2_vm (1) csv2_vm_update (1)
cloudscheduler version 2 7 November 2018 cloudscheduler(1)
Note
The results of an SQL query will be formatted differently from the Restructured Text tables shown above.