IBM PureData System for Analytics, Version 7.1

Using the vappcmd command

Read about the vappcmd command syntax.

Usage: vappcmd <subcommand> [<parameters>]
vappcmd -h
vappcmd -hc <subcommand>
Parameters:

-h - prints out command help
-hc - prints out subcommand help
-v - prints out version

Subcommands:

config - displays the basic information about VMs and host configuration
esx - configures connection parameters to vCenter server
start - powers on given SPU VMs
stop - powers off given SPU VMs

Subcommand config

This command displays the basic information about VMs and host configuration. Executed without parameters, it shows the data in a human-readable format.

Passing the -csv option causes the output to be presented in comma-separated format (no disk information included).

The -diskcsv option displays disk information in comma-separated format.

The command is not interactive.

Parameters:

-csv - formats output as comma-separated values
-diskcsv - displays disk information, formats output as csv

Usage: vappcmd config [-csv|-diskcsv]

CVS output format explanation:
  • CSV rows format for vappcmd config -csv

    Timestamps format is YYYY-mm-dd HH:MM:SS.

    Each row corresponds to a separate virtual machine.

    <timestamp>,<vApp name>,<vApp id>,<VM name>,<hipervisor host name>,<no cpu cores on hipervisor>,<no vcpu cores on VM>,<memory assigned to VM in MiB>,<vm uuid>,<hipervisor cpu description>,<hipervisor type>,<'|'-separated list of networks the VM is connected to>

  • CVS rows format for vappcmd config -diskcsv

    Each row corresponds to a separate disk connected to virtual machines.

    <timestamp>,<vApp name>,<vApp id>,<VM name>,<VM uuid>,<disk label>,<disk capacity in MiB>,<disk_uuid>,<datastore of disk image>

Note: There are some privileges that are required to run the vappcmd config command. For more information, read Requirements for ESXi user privileges .
Sample outputs of the vappcmd config command:
  • vappcmd config -csv with all privileges properly set:
    2013-12-04 05:17:27,IBM Netezza Platform Development Software 1,resgroup-v326,NPS,9.158.142.133,12,2,12288,
421322ff-030e-224b-7ef1-64016906d0c5,Intel(R) Xeon(R) CPU E5-2620 0 @ 2.00GHz,
VMware ESXi 5.1.0 build-1065491,External Network|Internal Fabric 1
2013-12-04 05:17:27,IBM Netezza Platform Development Software 1,resgroup-v326,SPU01,9.158.142.133,12,12,
18432,4213d753-9f70-f5da-d05f-bbff04f457c6,Intel(R) Xeon(R) CPU E5-2620 0 @ 2.00GHz,
VMware ESXi 5.1.0 build-1065491,Internal Fabric 1
  • vappcmd config -csv with some fields missing due to insufficient privileges:
    2013-12-04 08:38:44,IBM Netezza Platform Development Software 1,resgroup-v326,NPS,,,2,12288,
421322ff-030e-224b-7ef1-64016906d0c5,,,
2013-12-04 08:38:44,IBM Netezza Platform Development Software 1,resgroup-v326,SPU01,,,12,
18432,4213d753-9f70-f5da-d05f-bbff04f457c6,,,
The script was not able to gather all data. Set appropriate vSphere user's permissions 
to fix it.
    The warning from the last line goes to the error stream.
  • vappcmd config -diskcsv with all privileges properly set:
    2013-12-04 05:31:09,IBM Netezza Platform Development Software 1,resgroup-v326,NPS,421322ff-030e-224b-7ef1-64016906d0c5,
Hard disk 1,20480,6000C297-8e89-9f72-c4f6-270b8f59a8cd,Datastore0004
2013-12-04 05:31:09,IBM Netezza Platform Development Software 1,resgroup-v326,NPS,421322ff-030e-224b-7ef1-64016906d0c5,
Hard disk 2,20480,6000C293-5819-d793-a860-d15cee459c95,Datastore0004
2013-12-04 05:31:09,IBM Netezza Platform Development Software 1,resgroup-v326,NPS,421322ff-030e-224b-7ef1-64016906d0c5,
Hard disk 3,51200,6000C295-bbd8-a1f7-bf98-2d80d6a6ec15,Datastore0004
2013-12-04 05:31:09,IBM Netezza Platform Development Software 1,resgroup-v326,NPS,421322ff-030e-224b-7ef1-64016906d0c5,
Hard disk 4,20480,6000C298-0c88-72ab-6bb3-c639cdf7594f,Datastore0004
2013-12-04 05:31:09,IBM Netezza Platform Development Software 1,resgroup-v326,NPS,421322ff-030e-224b-7ef1-64016906d0c5,
Hard disk 5,102400,6000C291-ba8f-1262-926b-eb2a62dfed03,Datastore0004
2013-12-04 05:31:09,IBM Netezza Platform Development Software 1,resgroup-v326,SPU01,4213d753-9f70-f5da-d05f-bbff04f457c6,
Hard disk 1,51200,6000C298-e35e-6a91-144d-6bac1bcfbf07,Datastore0003
2013-12-04 05:31:09,IBM Netezza Platform Development Software 1,resgroup-v326,SPU01,4213d753-9f70-f5da-d05f-bbff04f457c6,
Hard disk 2,51200,6000C297-6b90-db2b-54e7-5e907c1bf52e,Datastore0003
2013-12-04 05:31:09,IBM Netezza Platform Development Software 1,resgroup-v326,SPU01,4213d753-9f70-f5da-d05f-bbff04f457c6,
Hard disk 3,51200,6000C29d-6612-807a-659b-3c63c6e12428,Datastore0003
2013-12-04 05:31:09,IBM Netezza Platform Development Software 1,resgroup-v326,SPU01,4213d753-9f70-f5da-d05f-bbff04f457c6,
Hard disk 4,51200,6000C295-d6a1-1394-cb1e-f24a9f996af4,Datastore0003
  • vappcmd config with some fields missing due to insufficient privileges:
    Timestamp: 2013-12-04 05:32:04
        Virtual appliance name: IBM Netezza Platform Development Software 1
    
        NPS (virtual machine):
                Hypervisor host: 9.158.142.133
                Hypervisor type: VMware ESXi 5.1.0 build-1065491
                Hypervisor CPU model: Intel(R) Xeon(R) CPU E5-2620 0 @ 2.00GHz
                Hypervisor CPU cores count: 12
                VM vCPUs count: 2
                VM memory: 12288 MiB
                Networks: External Network, Internal Fabric 1
                Disk 1:
                        label: Hard disk 1
                        capacity: 20480 MiB
                        datastore: Datastore0004
                Disk 2:
                        label: Hard disk 2
                        capacity: 20480 MiB
                        datastore: Datastore0004
                Disk 3:
                        label: Hard disk 3
                        capacity: 51200 MiB
                        datastore: Datastore0004
                Disk 4:
                        label: Hard disk 4
                        capacity: 20480 MiB
                        datastore: Datastore0004
                Disk 5:
                        label: Hard disk 5
                        capacity: 102400 MiB
                        datastore: Datastore0004
    
    
        SPU01 (virtual machine):
                Hypervisor host: 9.158.142.133
                Hypervisor type: VMware ESXi 5.1.0 build-1065491
                Hypervisor CPU model: Intel(R) Xeon(R) CPU E5-2620 0 @ 2.00GHz
                Hypervisor CPU cores count: 12
                VM vCPUs count: 12
                VM memory: 18432 MiB
                Networks: <value not available>
                Disk 1:
                        label: Hard disk 1
                        capacity: 51200 MiB
                        datastore: Datastore0003
                Disk 2:
                        label: Hard disk 2
                        capacity: 51200 MiB
                        datastore: Datastore0003
                Disk 3:
                        label: Hard disk 3
                        capacity: 51200 MiB
                        datastore: Datastore0003
                Disk 4:
                        label: Hard disk 4
                        capacity: 51200 MiB
                        datastore: Datastore0003

        The script was not able to gather all data. Set appropriate vSphere user's permissions 
to fix it.
    The warning from the last line goes to the error stream.

Subcommand esx

This command can be run by nz user only to configure connection to vCenter.

The command is interactive - asks user for all data that is not set in command-line parameters.

Parameters:

-s <IP_or_hostname> - vCenter server IP address or hostname.
-P <port> - vCenter server port number.
-u <username> - vCenter server user name.
-p <password> - vCenter server user password.

Usage: vappcmd esx [-s <server>] [-P <port>] [-u <username>] [-p <password>]

Subcommand start

This command can be run by any user to power on given SPU VMs. If the command is executed without parameters, it will power on all SPU VMs.

The command is not interactive.

Parameters:

<list_of_spus> - This is an optional parameter. It must have the following format:
spuxx01[,spuxx01]+
where xx is the SPU number.

Usage: vappcmd start [spuxx01[,spuxx01]+]

Examples:
vappcmd start
vappcmd start spu0101
vappcmd start spu0101,spu0201

Subcommand stop

This command can be run by any user to power off given SPU VMs. If the command is executed without parameters, it powers off all SPU VMs.

The command is not interactive.

Parameters:

<list_of_spus> - This is an optional parameter. It must have the following format:
spuxx01[,spuxx01]+
where xx is the SPU number.

Usage: vappcmd stop [spuxx01[,spuxx01]+]

Examples:
vappcmd stop
vappcmd stop spu0101
vappcmd stop spu0101,spu0201
Parent topic: Using IBM Netezza Platform Development Software

Feedback | Copyright IBM Corporation 2014 | Last updated: 2014-02-28