WilliamLam.com

How to Change the IP Address for vCenter Operations 5 vApp

by // 11 Comments

There was an interesting question on twitter from Matt Cowger yesterday asking how to modify the IP Address of the Analytics VM in the new vCenter Operations 5 vApp after it has been deployed. The new VC Ops 5 is actually composed of two virtual machines: UI and Analytics VM. As part of the initial deployment, they're is an exchange of information between the two VMs to properly get setup which includes the IP Addresses of each other. Simply modifying the IP Address of either VM will result in VC Ops not functioning correctly.

I personally have not had to re-IP my home deployment of VC Ops, but I did have some experience with CapacityIQ before it was combined into the VC Ops product and there was a nifty CLI tool called ciq-admin that was not very well known. I thought I check to see if the new VC Ops had something similar and to my surprise, an updated version of the tool exists and has been renamed to vcops-admin.

After a few minutes of looking around, it was clear that one could modify the IP Address of the Analytics VM and here are three simple steps.

Disclaimer: This is for educational purposes only, this is not officially supported by VMware. Please ensure you test and backup your system before making any changes in a real production system. Data that was previously collected will still be available after the change of an IP Address.

Modifying IP Address for Analytics VM:

Step 1 - First we need to shutdown VC Ops, you can do this from the administrator page by going to https://[vcops-ip]/admin and stopping the service under the Status tab. In this example, I will be showing you how to so using the CLI on the UI VM (this is primary system you use to access VC Ops)

You will need to sudo to "admin" user to run the command "vcops-admin stop". If you accidentally logged into the analytics VM and try to run the command, you will receive an error as the CLI is only available on the UI VM.

Step 2 - Log into the remote console of the analytics VM, this is required as you will be changing the IP Address and may possible impact network traffic. You will need to edit /etc/sysconfig/network/ifcfg-eth0 using an editor such as "vi" and specify the IP Address you wish to change to. Once you are done, you will need to restart the network interface for the changes to take effect. To so so, run the following command "service network restart".

Step 3 - Go back to the UI VM (you will need to sudo over to "admin" account if you are not already) and you will now need to "repair" the connection between the UI and Analytics VM to ensure they can communicate with each other. To do so, you will run the following command "vcops-admin repair --ipaddress [new-analytics-ip]". If the UI VM is able to successfully connect to the new IP Address of the Analytics VM, it will automatically start up the VC Ops service. Once the service has been started, VC Ops is now running and operational.

Now what if you want to change the UI VM's IP Address? I thought this should be pretty straight forward right? Well, it took me a bit longer than I was expecting but the process is just four easy steps.

Modifying IP Address for UI VM:

Step 1 - Stop VC Ops service, you can do this using the admin portal or via SSH as shown in Step 1 of Analytics VM

Step 2 - Login to the remote console of the UI VM this is required as you will be changing the IP Address and may possible impact network traffic. You will need to edit /etc/sysconfig/network/ifcfg-eth0 using an editor such as "vi" and specify the IP Address you wish to change to. Once you are done, you will need to restart the network interface for the changes to take effect. To so so, run the following command "service network restart".

Step 3 - Login via SSH to UI VM using the new IP Address (you will need to sudo over to "admin" account if you are not already) and you will now need to "repair" the connection between the UI and Analytics VM to ensure they can communicate with each other. To do so, you will run the following command "vcops-admin repair --ipaddress [new-analytics-ip]". If the UI VM is able to successfully connect to the Analytics VM, it will automatically start up the VC Ops service.

Step 4 - The last step is to update the vCenter VC Ops plugin information so when you navigate to the VC Ops extension, it knows the new IP Address. This step can be done by logging into the admin portal and under "Registration" tab, you will need to click on the "update" button for each and every vCenter that is attached to the VC Ops. In this example, I will show how to do so using the "vcops-admin" CLI. You will need to run the following command:

vcops-admin register update --vc-name [vc-name] --vc-server [https://vc-server/sdk] --username [vc-username] --password [vc-password] --force

Note: This process may take a few minutes for each vCenter that you need to update, also if you  have a dedicated service account for the collector, you can specify --collection-user and --collection-password agruments.

Though the process of modifying the IP Address is not available through the UI today, it is a feature that I will be requesting as this should be a trivial task for users.

Extracting GuestOS IDs From vCloud Director

by // 1 Comment

There was an interesting question on the VMTN forums last week on capturing the list of supported guest operating systems using the vCloud APIs. This feature is currently not available today using the vCloud API, as it there is no way to extract the list of supported guestOS identifiers. If you take a look at the vCloud Director User Guide, you can get a list of supported guestOSes, but it does not translate to the API identifiers that is needed when provisioning a VM in vCloud Director.

The list of supported guestOS types are stored in the vCloud Director database and you can extract the guestOS IDs if you have access to the database or a DBA that manages the database. Using the following SQL query, you can get the list of supported guestOSes that includes the API ID and description. Since the list of guestOSes are inserted upon installation, I have already captured the output for a default vCloud Director 1.5 instance for your reference.

Disclaimer: This SQL query is not supported by VMware nor should you directly access the vCloud Database as a best practice without the consent of VMware Support.

In this example, I am querying the list of default guestOSes from a vCloud Director 1.5 instance that was installed on Oracle XE database.

First you need to set several environmental variables for your respective ORACLE_HOME, ORACLE_SID and update your PATH variable (your paths will vary based on your installation + OS):

[root@vcd ~]# export ORACLE_HOME=/u01/app/oracle/product/11.2.0/xe
[root@vcd ~]# export ORACLE_SID=XE
[root@vcd ~]# export PATH=$ORACLE_HOME/bin

Next we will login using sqlplus and you will need to know the username and password of the vCloud Director database that was configured during installation:

[root@vcd ~]# sqlplus "vcloud/vcloud"
SQL*Plus: Release 11.2.0.2.0 Production on Tue Nov 1 19:30:24 2011
Copyright (c) 1982, 2011, Oracle. All rights reserved.
Connected to:
Oracle Database 11g Express Edition Release 11.2.0.2.0 - 64bit Production

Before we execute the query, we need to set a few parameters to help with the readability of the output:

SET ECHO OFF
SET WRAP OFF
SET FEEDBACK OFF
SET PAGESIZE 0
SET HEADING OFF

Now we are ready to execute the SQL statement:

SQL> select internal_name||' == '||display_name from guest_os_type order by display_name;

Note: I am not a SQL expert nor DBA, I am sure there are other variations of formatting.

Here is a screenshot of the execution above:

The list of supported default guestOS types in vCloud Director 1.5 is 80:

guestOS Identifier guestOS Descriptioin
asianux3Guest Asianux 3 (32-bit)
asianux3_64Guest Asianux 3 (64-bit)
asianux4Guest Asianux 4 (32 bit)
asianux4_64Guest Asianux 4 (64 bit)
centosGuest CentOS 4/5/6 (32-bit)
centos64Guest CentOS 4/5/6 (64-bit)
dosGuest DOS
debian4Guest Debian GNU/Linux 4 (32-bit)
debian4_64Guest Debian GNU/Linux 4 (64-bit)
debian5Guest Debian GNU/Linux 5 (32-bit)
debian5_64Guest Debian GNU/Linux 5 (64-bit)
debian6Guest Debian GNU/Linux 6 (32 bit)
debian6_64Guest Debian GNU/Linux 6 (64 bit)
freebsdGuest FreeBSD (32-bit)
freebsd64Guest FreeBSD (64-bit)
win2000AdvServGuest Microsoft Windows 2000 Advanced Server
win2000ProGuest Microsoft Windows 2000 Professional
win2000ServGuest Microsoft Windows 2000 Server
win31Guest Microsoft Windows 3.1
windows7Guest Microsoft Windows 7 (32-bit)
windows7_64Guest Microsoft Windows 7 (64-bit)
win95Guest Microsoft Windows 95
win98Guest Microsoft Windows 98
winNTGuest Microsoft Windows NT 4
winNetDatacenterGuest Microsoft Windows Server 2003, Datacenter Edition (32-bit)
winNetDatacenter64Guest Microsoft Windows Server 2003, Datacenter Edition (64-bit)
winNetEnterpriseGuest Microsoft Windows Server 2003, Enterprise Edition (32-bit)
winNetEnterprise64Guest Microsoft Windows Server 2003, Enterprise Edition (64-bit)
winNetStandardGuest Microsoft Windows Server 2003, Standard Edition (32-bit)
winNetStandard64Guest Microsoft Windows Server 2003, Standard Edition (64-bit)
winNetWebGuest Microsoft Windows Server 2003, Web Edition
winLonghornGuest Microsoft Windows Server 2008 (32-bit)
winLonghorn64Guest Microsoft Windows Server 2008 (64-bit)
windows7Server64Guest Microsoft Windows Server 2008 R2 (64-bit)
winNetBusinessGuest Microsoft Windows Small Business Server 2003
winVistaGuest Microsoft Windows Vista (32-bit)
winVista64Guest Microsoft Windows Vista (64-bit)
winXPProGuest Microsoft Windows XP Professional (32-bit)
winXPPro64Guest Microsoft Windows XP Professional (64-bit)
netware5Guest Novell NetWare 5.1
netware6Guest Novell NetWare 6.x
os2Guest OS/2
oesGuest Open Enterprise Server
oracleLinuxGuest Oracle Linux 4/5/6 (32 bit)
oracleLinux64Guest Oracle Linux 4/5/6 (64 bit)
otherGuest Other (32-bit)
otherGuest64 Other (64-bit)
other24xLinuxGuest Other 2.4x Linux (32-bit)
other24xLinux64Guest Other 2.4x Linux (64-bit)
other26xLinuxGuest Other 2.6x Linux (32-bit)
other26xLinux64Guest Other 2.6x Linux (64-bit)
otherLinuxGuest Other Linux (32-bit)
otherLinux64Guest Other Linux (64-bit)
rhel2Guest Red Hat Enterprise Linux 2
rhel3Guest Red Hat Enterprise Linux 3 (32-bit)
rhel3_64Guest Red Hat Enterprise Linux 3 (64-bit)
rhel4Guest Red Hat Enterprise Linux 4 (32-bit)
rhel4_64Guest Red Hat Enterprise Linux 4 (64-bit)
rhel5Guest Red Hat Enterprise Linux 5 (32-bit)
rhel5_64Guest Red Hat Enterprise Linux 5 (64-bit)
rhel6Guest Red Hat Enterprise Linux 6 (32-bit)
rhel6_64Guest Red Hat Enterprise Linux 6 (64-bit)
openServer5Guest SCO OpenServer 5
openServer6Guest SCO OpenServer 6
unixWare7Guest SCO UnixWare 7
eComStationGuest Serenity eComStation 1
eComStation2Guest Serenity eComStation 2
solaris10Guest Sun Solaris 10 (32-bit)
solaris10_64Guest Sun Solaris 10 (64-bit)
solaris11_64Guest Sun Solaris 11 (64 bit)
solaris8Guest Sun Solaris 8 (experimental)
solaris9Guest Sun Solaris 9 (experimental)
sles10Guest Suse Linux Enterprise 10 (32-bit)
sles10_64Guest Suse Linux Enterprise 10 (64-bit)
sles11Guest Suse Linux Enterprise 11 (32-bit)
sles11_64Guest Suse Linux Enterprise 11 (64-bit)
slesGuest Suse Linux Enterprise 8/9 (32-bit)
sles64Guest Suse Linux Enterprise 8/9 (64-bit)
ubuntuGuest Ubuntu Linux (32-bit)
ubuntu64Guest Ubuntu Linux (64-bit)

If you have ever worked with the vSphere API, you will notice the guestOS API IDs are exactly the same as the guestOS Identifiers found in the vSphere API. vSphere 5 supports a total of 105 guestOSes and 80 of those are supported in vCloud Director.

A feature request has already been submitted to be able to query for the list of supported guestOSes using the vCloud API. For now, this is another way of retrieving API guestOS identifier without having to manually create each guestOS type through the web interface and query for the identifier.

vCloud Director Report 1.0.0

by // 4 Comments

Over the winter holiday I started to explore the vCloud API and one of our SDKs, vCloud SDK for PHP. VMware provides two additional vCloud SDKs: Java and .NET. I had used Java in college and I wanted to stay away from anything Windows related, so I thought I give PHP a try and it was the closest thing to Perl 😉

Since this was my first time using the vCloud API and SDK, I thought what better way to learn than to create a script similar to my vSphere Health Check Report for vCloud Director? This not only helped me to understand the objects in vCloud Director from an API perspective but no such reporting tool exists today for administrators and end users of vCloud Director.

Here is an example of what a report could look like: vCloudDirectorReport.html

To use the script, you will need the following per-requiste:

  • Install vCloud SDK for PHP, take a look at article on how to get setup.
  • Running vCloud Director 1.5 (Script uses the new API Query Service)
  • Download both config.php which includes configuration parameters for the script and vmwarevCloudDirectorReport.php script.

To get a list of the available commandline options, just type "php vmwarevCloudDirectorReport.php":

php vmwarevCloudDirectorReport.php

Error: missing required parameters
Usage:

[Script]
VMware vCloud Director Report v1.0.0

[Description]
This script provides a detail report of your VMware vCloud Director system

[Usage]
# php vCloudReport.php -s -u -p [Options]

-s|--server [req] IP or hostname of the vCloud Director.
-u|--user [req] User name in the form user@organization for the vCloud Director instance.
-p|--pswd [req] Password for user.
-t|--type [req] Type of report [system|orgadmin|orguser].

[Options]
-r|--report [opt*] Name of html output file (e.g. vCloudReport.html).

[Examples]
# php query.php -s 127.0.0.1 -u admin@system -p password -t system
# php query.php -s 127.0.0.1 -u admin@coke -p password -t orgadmin
# php query.php -s 127.0.0.1 -u admin@pepsi -p password -t orguser

The config.php can be used to store the vCloud URL and credentials or you may specify it via the commandline using -s, -u and -p arguments. In addition, you will also need to specify -t flag which is based on the type of user you are logging into whether that is system (administrator), orgadmin or orguser.

The report can easily be customized by toggling parameters in config.php which includes the following parameters:

Depending on the report type, certain flags will be applicable. By default, all flags are enabled but you my disable ones you do not wish to see.

Here is an example of the script logging into vCloud Director instance with the administrator account in the System organization:

This is the first iteration of the script, I plan on adding additional information and if you have any feedback/suggestions, please leave a comment below.