Cisco CSR 1000V Series Cloud Services Router Software Configuration Guide
Installing the Cisco CSR 1000V in VMware ESXi Environments
Downloads: This chapterpdf (PDF - 679.0KB) The complete bookPDF (PDF - 3.44MB) | Feedback

Table of Contents

Installing the Cisco CSR 1000V in VMware ESXi Environments

VMware ESXi Support Information

Supported VMware Features and Operations

Installation Requirements for VMware ESXi

Deploying the Cisco CSR 1000V OVA Template to the VM

Deploying the OVA Template to the VM

Deploying the Cisco CSR 1000V Software Using the Cisco Build, Deploy, Execute OVF Tool

Editing the Cisco CSR 1000V Basic Properties Using the vSphere GUI

Adding Custom Properties for the Cisco CSR 1000V

Manually Creating the VM and Installing the Cisco CSR 1000V Software Using the .iso File (VMware ESXi)

Overview of Tasks for Manually Creating the Cisco CSR 1000V VM

Manually Creating the Cisco CSR 1000V VM Using the .iso File (VMware ESXi)

Increasing Performance on VMware E SXi Configurations

VMware ESXi Support Information

The Cisco CSR 1000V runs on the VMware ESXi hypervisor. You can use the same VMware vSphere hypervisor to run several VMs. Use the VMware vSphere Client GUI to create and manage VMs.

The VMware vSphere Client is an application for creating, configuring, and managing VMs on the VMware vCenter Server. The Cisco CSR 1000V can boot from a virtual disk located on the data store. You can perform basic administration tasks such as starting and stopping the Cisco CSR 1000V using the VMware vSphere Client.

VMware vCenter Server manages the vSphere environment and provides unified management of all the hosts and VMs in the data center from a single console.

Table 4-1 lists the VMware virtual machine vendor tools supported for the Cisco CSR 1000V.

Table 4-1 VMware Virtual Machine Requirements

Cisco CSR 1000V Version
Supported Tools and Requirements
Supported vSwitch

Cisco IOS XE Release 3.9S

PC running the following:

  • VMware vSphere Client 5.0

Server running the following:1

  • VMware ESXi 5.0

Installation Tool:

  • VMware vCenter

VMware standard switch

VMware distributed switch

Cisco IOS XE Release 3.10S and 3.11S

PC running the following:

  • VMware vSphere Client 5.0

Server running the following:1

  • VMware ESXi 5.0 or 5.1

Installation Tool:

  • VMware vCenter

VMware standard switch

VMware distributed switch

Cisco IOS XE Release 3.12S and later

PC running the following:

  • VMware vSphere Client 5.0, 5.1, or 5.5

Server running the following:1

  • VMware ESXi 5.0, 5.1, or 5.5

Installation Tool:

  • VMware vCenter

VMware standard switch

VMware distributed switch

1.For more information about server requirements, see the Cisco CSR 1000V Series Cloud Services Router Release Notes.

Table 4-2 lists the virtual machine requirements for the Cisco CSR 1000V.

Table 4-2 VMware Requirements for Cisco CSR 1000V

Cisco CSR 1000V Release
VM Configuration Requirements

Cisco IOS XE Release 3.9S

  • VMware ESXi 5.0
  • Single hard disk

Note Multiple hard disk drives on a VM are not supported.

  • 8 GB virtual disk
  • 4 virtual CPUs
  • 4 GB of RAM
  • 3 or more virtual network interface cards

Cisco IOS XE Release 3.10S

  • VMware ESXi 5.0 or 5.1
  • Single hard disk

Note Multiple hard disk drives on a VM are not supported.

  • 8 GB virtual disk
  • The following virtual CPU configurations are supported:

1 virtual CPU, requiring 2.5 GB minimum of RAM

4 virtual CPUs, requiring 4 GB minimum of RAM

  • 3 or more virtual network interface cards

Cisco IOS XE Release 3.11S

  • VMware ESXi 5.0 or 5.1
  • Single hard disk

Note Multiple hard disk drives on a VM are not supported.

  • 8 GB virtual disk
  • The following virtual CPU configurations are supported:

1 virtual CPU, requiring 2.5 GB minimum of RAM

2 virtual CPUs, requiring 2.5 GB minimum of RAM

4 virtual CPUs, requiring 4 GB minimum of RAM

  • 3 or more virtual network interface cards

Cisco IOS XE Release 3.12 and 3.13S

  • VMware ESXi 5.0, 5.1, or 5.5
  • Single hard disk

Note Multiple hard disk drives on a VM are not supported.

  • 8 GB virtual disk
  • The following virtual CPU configurations are supported:

1 virtual CPU, requiring 2.5 GB minimum of RAM

2 virtual CPUs, requiring 2.5 GB minimum of RAM

4 virtual CPUs, requiring 4 GB minimum of RAM

8 virtual CPUs, requiring 4 GB minimum of RAM

  • 3 or more virtual network interface cards

Supported VMware Features and Operations

VMware supports various features and operations that allow you to manage your virtual applications and perform operations such as cloning, migration, shutdown and resume.

Some of these operations cause the runtime state of the VM to be saved and then restored upon restarting. If the runtime state includes traffic-related state, then on resumption or replaying the runtime state, additional errors, statistics, or messages are displayed on the user console. If the saved state is just configuration driven, you can use these features and operations without a problem.

Table 4-7 lists the VMware features and operations that are supported on the Cisco CSR 1000V. For more information about VMware features and operations, see the VMware Documentation .

The following VM features and operations are not supported in all versions of the Cisco CSR 1000V, but can still be used or performed on non-supported versions at the risk of encountering dropped packets, dropped connections, and other error statistics:

  • Distributed Resource Scheduling (DRS)
  • Fault Tolerance
  • Resume
  • Snapshot
  • Suspend

See the following table for more information.

 

Table 4-3 Supported VMware Features and Operations: General Features (for vCenter Server Only)

Supported Entities
First Supported Cisco CSR 1000V Release
Description

Cloning

Cisco IOS XE Release 3.9S2

Enables cloning a virtual machine or template, or cloning a virtual machine to a template.

Migrating

Cisco IOS XE Release 3.9S

The entire state of the virtual machine as well as its configuration file, if necessary, is moved to the new host even while the data storage remains in the same location on shared storage.

vMotion

Cisco IOS XE Release 3.9S

Enables moving the VM from one physical server to another while the VM remains active.

Template

Cisco IOS XE Release 3.9S

Uses templates to create new virtual machines by cloning the template as a virtual machine.

2.This release is a Controlled Availability release limited to selected customers only.

 

Table 4-4 Supported VMware Features and Operations: Operations (for Both vCenter Server and vSphere Client)

Supported Entities
First Supported Cisco CSR 1000V Release
Description

Power On

Cisco IOS XE Release 3.9S

Powers on the virtual machine and boots the guest operating system if the guest operating system is installed.

Power Off

Cisco IOS XE Release 3.9S

Stops the virtual machine until it is powered back. The power off option performs a “hard” power off, which is analogous to pulling the power cable on a physical machine and always works.

Shut Down

Not supported.

Shut Down, or “soft” power off, leverages VMware Tools to perform a graceful shutdown of a guest operating system. In certain situations, such as when VMware Tools is not installed or the guest operating system is hung, shut down might not succeed and using the Power off option is necessary.

Suspend

Not supported

Suspends the virtual machine.

Reset/Restart

Cisco IOS XE Release 3.9S

Stops the virtual machine and restarts (reboots) it.

OVF Creation

Cisco IOS XE Release 3.9S

An OVF package captures the state of a virtual machine into a self-contained package. The disk files are stored in a compressed, sparse format. You can create the OVF file by exporting it to your local computer.

OVA Creation

Cisco IOS XE Release 3.9S

Single file (OVA) to package the OVF template into a single .ova file. This enables distributing the OVF package as a single file if it needs to be explicitly downloaded from a website or moved around using a USB key.

 

Table 4-5 Supported VMware Features and Operations: Networking Features

Supported Entities
First Supported Cisco CSR 1000V Release
Description

Custom MAC address

Cisco IOS XE Release 3.9S

From both vCenter Server and vSphere Client. Allows you to set up the MAC address manually for a virtual network adapter.

Distributed VSwitch

Cisco IOS XE Release 3.9S

From vCenter Server only. A vSphere distributed switch on a vCenter Server data center can handle networking traffic for all associated hosts on the data center.

Distributed Resources Scheduler

Cisco IOS XE Release 3.10S

Provides automatic load balancing across hosts.

NIC Load Balancing

Cisco IOS XE Release 3.9S

From both vCenter Server and vSphere Client. Load balancing and failover policies allow you to determine how network traffic is distributed between adapters and how to reroute traffic if an adapter fails.

NIC Teaming

Cisco IOS XE Release 3.9S

From both vCenter Server and vSphere Client. Allows you to set up an environment where each virtual switch connects to two uplink adapters that form a NIC team. The NIC teams can then either share the load of traffic between physical and virtual networks among some or all of its members, or provide passive failover in the event of a hardware failure or a network outage.

Note NIC Teaming can cause a large number of ARP packets to flood the Cisco CSR 1000V and overload the CPU. To avoid this situation, reduce the number of ARP packets and implement NIC Teaming as Active-Standby rather than Active-Active.

vSwitch

Cisco IOS XE Release 3.9S

From both vCenter Server and vSphere Client. A vSwitch is a virtualized version of a Layer 2 physical switch. A vSwitch can route traffic internally between virtual machines and link to external networks. You can use vSwitches to combine the bandwidth of multiple network adapters and balance communications traffic among them. You can also configure a vSwitch to handle a physical NIC failover.

 

Table 4-6 Supported VMware Features and Operations: High Availability

Supported Entities
First Supported Cisco CSR 1000V Release
Description

VM-Level High Availability

Cisco IOS XE Release 3.9S

To monitor operating system failures, VM-Level High Availability monitors heartbeat information in the VMware High Availability cluster. Failures are detected when no heartbeat is received from a given virtual machine within a user-specified time interval. VM-Level High Availability is enabled by creating a resource pool of VMs using VMware vCenter Server.

Host-Level High Availability

Cisco IOS XE Release 3.9S

To monitor physical servers, an agent on each server maintains a heartbeat with the other servers in the resource pool such that a loss of heartbeat automatically initiates the restart of all affected virtual machines on other servers in the resource pool. Host-Level High Availability is enabled by creating a resource pool of servers or hosts, and enabling high availability in vSphere.

Fault Tolerance

Cisco IOS XE Release 3.10S

Using high availability, fault tolerance is enabled on the ESXi host. When you enable fault tolerance on the VM running the Cisco CSR 1000V, a secondary VM on another host in the cluster is created. If the primary host goes down, then the VM on the secondary host will take over as the primary VM for the Cisco CSR 1000V.


Note The Cisco CSR 1000V does not use or support Cisco IOS-based high availability. High Availability is supported on the VM host only.


 

Table 4-7 Supported VMware Features and Operations: Storage Options (for Both vCenter Server and vSphere Client)

Supported Entities
First Supported Cisco CSR 1000V Release
Description
Storage Options (for both vCenter Server and vSphere Client)

Local Storage

Cisco IOS XE Release 3.9S

Local storage is in the internal hard disks located inside your ESXi host. Local storage devices do not support sharing across multiple hosts. A datastore on a local storage device can be accessed by only one host.

External Storage Target

Cisco IOS XE Release 3.9S

You can deploy the Cisco CSR 1000V on external storage, that is, a Storage Area Network (SAN).

Mount or Pass Through of USB Storage

Cisco IOS XE Release 3.9S

You can connect USB sticks to the Cisco CSR 1000V and use them as storage devices. In ESXi, you need to add a USB controller and then assign the disk devices to the Cisco CSR 1000V.

  • Cisco CSR 1000V supports USB disk hot-plug.
  • You can use only two USB disk hot-plug devices at a time.
  • USB hub is not supported.

Installation Requirements for VMware ESXi

Before starting your installation of the Cisco CSR 1000V, you must first set up your VMware environment, including the necessary host and client software. For example, if you are installing the Cisco CSR 1000V in a VMware ESXi environment, you must first install the vSphere Client.

Table 4-8 lists the installation requirements for VMware ESXi.

Table 4-8 Installation Requirements for VMware ESXi

VMware ESXi Requirement
Cisco IOS XE Release 3.9S
Cisco IOS XE Release 3.10S
Cisco IOS XE Release 3.11S
Cisco IOS XE Release 3.12S and 3.13S

VMware ESXi version(s) supported

5.0

5.0, 5.1

5.0, 5.1

5.0, 5.1, 5.5

Supported vCPU configurations3

1 vCPU: requires minimum 4 GB RAM allocation

  • 1 vCPU: requires minimum 2.5 GB RAM allocation4
  • 4 vCPUs: requires minimum 4 GB RAM allocation
  • 1 vCPU: requires minimum 2.5 GB RAM allocation2
  • 2 vCPUs: requires minimum 2.5 GB RAM allocation
  • 4 vCPUs: requires minimum 4 GB RAM allocation
  • 1 vCPU: requires minimum 2.5 GB RAM allocation2
  • 2 vCPUs: requires minimum 2.5 GB RAM allocation
  • 4 vCPUs: requires minimum 4 GB RAM allocation
  • 8 vCPUs: requires minimum 4 GB RAM allocation

Virtual CPU cores required5

1

1

1

1

Virtual hard disk size

8 GB minimum

8 GB minimum

8 GB minimum

8 GB minimum

Supported vNICs

VMXNET3

VMXNET3

VMXNET3

VMXNET3

Minimum number of vNICs required6

3

3

3

3

Maximum number of vNICs supported

10

10

10

10

Default video, SCSI controller set

Required

Required

Required

Required

Virtual CD/DVD drive installed

Required

Required

Required

Required

3.The required vCPU configuration depends on the throughput license and technology package installed. For more information, see the data sheet for your release.

4.Not automatically supported when deploying the OVA. If configuring Cisco Network Based Application Recognition (NBAR), or Cisco Application Visibility and Control (AVC), a 4-GB RAM allocation is required.

5.Requires a 64-bit processor with Virtualization Technology (VT) enabled in the BIOS setup of the host machine.

6.When deploying the OVA, three vNICs are automatically created. You can manually add vNICs to the VM after the Cisco CSR 1000V has booted.

Deploying the Cisco CSR 1000V OVA Template to the VM

You can use the provided CSR 1000V OVA file package to easily deploy the Cisco CSR 1000V to the VM. The OVA package includes an .ovf file that contains a default VM configuration based on the Cisco IOS XE release and the supported hypervisor. See the “Guidelines and Limitations” section of the installation configuration that is included in the OVA file.


Note The Citrix XenServer, KVM and Microsoft Hyper-V implementations do not support deploying the VM using the .ova file. You must manually install the VM using the .iso file.


Deploying the OVA Template to the VM

The following restrictions apply to deploying the OVA template to the VM:

  • (Cisco IOS XE Releases 3.10S and 3.11S) The OVA package only creates a VM with 4 virtual CPUs. To change to the 1 or 2 virtual CPU configuration, you must first deploy the OVA template, and then use vSphere to change the virtual CPU configuration and the required RAM allocation.

If the virtual CPU configuration is changed, the Cisco CSR 1000V must be rebooted. Changing the RAM allocation does not require rebooting the Cisco CSR 1000V. Beginning with Cisco IOS XE 3.12S, the OVA package provides an option to select the virtual CPU configuration.


Note When deploying the OVA package, the VM requires two virtual CD/DVD drives, one for the OVF environment file and one for the .iso file.


Perform the following steps in VMware vSphere Client:


Step 1 Log in to the VMware vSphere Client.

Step 2 From the vSphere Client Menu Bar, choose File > Deploy OVF Template.

Step 3 In the OVA Wizard, point the source to the Cisco CSR 1000V OVA to be deployed. Click Next.

The OVF Template Details displays, showing information about the OVA file. Click Next.

Step 4 Under Name and Inventory Location, specify the name for the VM and click Next.

Step 5 (Cisco IOS XE Release 3.12S and later): Under Deployment Configuration, select the desired hardware configuration profile from the drop-down menu and click Next.

Step 6 Under Storage, select the Datastore to use for the VM. Click Next.

Step 7 Under Disk Format, select the disk format option:

  • Thick Provision Lazy Zeroed
  • Thick Provision Eager Zeroed

Note The Thin Provision option is not supported. The Thick Provision Eager Zeroed option takes longer to install but provides better performance.


Click Next.

Step 8 Under Network Mapping, allocate one or more virtual network interface card (vNIC) on the destination network using the drop-down list. The options for mapping the vNICs differ depending on the release version:

  • (Cisco IOS XE Release 3.11S and later): Select the network mappings for the 3 default vNICs created during the OVA deployment. You can choose which vNIC will map to the router’s management interface when setting the bootstrap properties (see Table 4-10 ).
  • (Cisco IOS XE Release 3.10S and earlier) The vNIC allocated in this step is mapped to the GigabitEthernet0 management interface on the router.

Select the vNIC to connect at Power On. Click Next.

When the Cisco CSR 1000V installation using the OVA template is complete, two additional vNICS are allocated. The Cisco CSR 1000V supports up to ten vNICs; additional vNICs must be manually created on the VM.

The Properties screen displays.

Step 9 Configure the properties for the VM.

The available properties differ depending on the Cisco IOS XE release that you are using. See Table 4-9 for Cisco IOS XE Release 3.9S and 3.10S and Table 4-10 for Cisco IOS XE Release 3.11S and later.


Note The bootstrap properties are optional when creating the VM. You can set these properties to easily provision the VM before starting it up.


Table 4-9 OVA Bootstrap Properties for Cisco IOS XE Release 3.9S and 3.10S

Property
Description
Bootstrap Properties

Login Username

Sets the login username for the router.

Login Password

Sets the login password for the router.

Management IPv4 Address/Mask

Sets the management gateway address/mask in IPv4 format for the GigabitEthernet0 management interface.

Management IPv4 Default Gateway

Sets the default management gateway IP address in IPv4 format for the GigabitEthernet0 management interface.

Router name

Configures the hostname of the router.

Features

Enable HTTP Server

(Cisco IOS XE Release 3.9S only) Enables an HTTP server for system configuration and administration via a web browser.

Enable HTTPS Server

(Cisco IOS XE Release 3.10S only) Enables an HTTPS server for system configuration and administration via a web browser. Required if using the REST API to perform system configuration.

Note The HTTPS server is enabled by default beginning in Cisco IOS XE Release 3.11S. This field was removed.

Enable SSH Login

Enables remote login using SSH and disables remote login via Telnet. Requires that the login username and password are set.

Additional Configuration Properties

Enable Password

Configures the password for privileged (enable) access.

Domain Name

Configures the network domain name.

Table 4-10 OVA Bootstrap Properties for Cisco IOS XE Release 3.11S and Later

Property
Description
Bootstrap Properties

Login Username

Sets the login username for the router.

Login Password

Sets the login password for the router.

Management Interface

Designates the management interface for the Cisco CSR 1000V. The format must be GigabitEthernetx or GigabitEthernetx.xxx.

Note The GigabitEthernet0 interface is no longer supported beginning in Cisco IOS XE Release 3.11S.

Management vLAN

Configures the dot1Q VLAN interface. Requires the management interface to be configured using the GigabitEthernetx.xxx format.

Management Interface IPv4 Address/Mask

Configures the IPv4 address and subnet mask for the management interface.

Management IPv4 Default Gateway (Cisco IOS XE Release 3.11S)

Configures the IPv4 management default gateway address. If using DHCP, enter “dhcp” in the field.

Management IPv4 Gateway (Cisco IOS XE Release 3.12S)

Configures the IPv4 management default gateway address. If using DHCP, enter “dhcp” in the field.

Management IPv4 Network (Cisco IOS XE Release 3.12S)

Configures the IPv4 Network (such as “192.168.2.0/24” or “192.168.2.0 255.255.255.0”) that the management gateway should route to. If a default route (0.0.0.0/0) is desired, this may be left blank.

Remote Management IPv4 Address

(Optional) Configures the IP address used for remote management of the Cisco CSR 1000V by the REST API or by the Cisco Prime Network Services Controller. The address must be in the same subnet as the management interface address.

Note Beginning with Cisco IOS XE 3.13S, this option is not used if configuring the shared management interface to support REST API.

PNSC IPv4 Address

Configures the IP address of the Cisco Prime Network Services Controller.

This setting is used if you plan to remotely manage the Cisco CSR 1000V using the Cisco Prime Network Services Controller.

PNSC Agent Local Port

(Optional) Configures the Cisco Prime Network Services Controller service agent SSL port on the local Cisco CSR 1000V to receive policies from the service manager.

This setting is used if you plan to remotely manage the Cisco CSR 1000V using the Cisco Prime Network Services Controller.

PNSC Shared Secret Key

Configures the Cisco Prime Network Services Controller shared secret key for the Cisco Prime Network Services Controller agent to set the SSL certificate from the controller.

This setting is used if you plan to remotely manage the Cisco CSR 1000V using the Cisco Prime Network Services Controller.

Router name

Configures the hostname of the router.

Features

Enable SCP Server

Enables the IOS SCP feature.

Enable SSH Login (Cisco IOS XE Release 3.11S)

Enable SSH Login and Disable Telnet Login (Cisco IOS XE Release 3.12S and later)

Enables remote login using SSH and disables remote login via Telnet. Requires that the login username and password are set.

Additional Configuration Properties

Enable Password

Configures the password for privileged (enable) access.

Domain Name

Configures the network domain name.

License Boot Level (Cisco IOS XE 3.13S)

Configures the license technology level that is available when the Cisco CSR 1000V boots.

When finished configuring the router properties, click Next. The Ready to Complete screen displays, showing the settings to be used when the template is deployed.

You can also configure advanced properties after the router boots. See the .

Step 10 Select Power on after deployment to automatically power on the VM.

Step 11 Click Finish to deploy the OVA.

The OVA deploys the .iso file and, if the “Power on after deployment” setting is selected, automatically powers on the VM. Once the VM is powered on, the Cisco CSR 1000V begins the installation and boot process. If a bootstrap configuration file was included in the OVA, the router configuration will automatically be enabled.

See the “Booting the Cisco CSR 1000V and Accessing the Console” section.


 

Deploying the Cisco CSR 1000V Software Using the Cisco Build, Deploy, Execute OVF Tool

The Cisco Build, Deploy, Execute OVF (BDEO) tool included in the Cisco CSR 1000V software package is a Linux-based application that enables you to create attributes for one or more VMs and quickly deploy the VMs with the cloud services router software pre-installed. This tool can speed the process of deploying the Cisco CSR 1000V on multiple VMs.

The BDEO tool provides a simple command-line interface to enter the VM attributes into the .ova file. The BDEO tool can be run either in a LINUX shell or on Solaris, and VMware ovftools must be installed.


Note The BDEO tool is provided without official Cisco support and is to be used at your risk.


The following restrictions apply to the BDEO tool:

  • You can deploy the .ova file directly onto an ESXi host. The BDEO tool is not supported for Citrix XenServer, KVM, or Microsoft Hyper-V environments.
  • Beginning with Cisco IOS XE Release 3.12S, the CSR 1000V OVA provides the option to select multiple user-selectable hardware configuration profiles. The BDEO tool has not been extended to construct an enhanced OVA of this type; if using the BDEO tool to create a custom OVA, the resulting OVA will only define a single hardware profile.
  • The customization options under the “Virtual Machine Hardware”, “Virtual Machine Description”, and “Cisco IOS XE Configuration” are only used when constructing a new OVA with an .iso file as input (-i csr1000v.iso). The BDEO tool does not support modifying existing OVAs, so if an OVA is provided as input (-i csr1000v.ova), all options under these three heading categories will be silently ignored by the BDEO tool.

While the following procedure provides general guidance for how to deploy the Cisco CSR 1000V, the exact steps that you need to perform may vary depending on the characteristics of your VMware environment and setup.


Step 1 Download the .ova file from the Cisco CSR 1000V software installation image package:

Step 2 Extract the BDEO shell script tool from the OVA package.

For example, you could use the following Linux command:

tar xvf [ file. ova ] bdeo.sh README-BDEO.txt

Step 3 Run the BDEO shell script with the command-line parameters that you wish to use. You can run it with “-h” in order to get a listing of supported parameters, or refer to the following table.

All of the commands below are optional except for the -i | -image command.


Note The default values may vary depending on the Cisco CSR 1000V version.


Table 4-11 BDEO Command-Line Bootstrap Properties

Command Name
Parameters
Description
Input/Output Options

-i | -image

path

Enters one of the following:

  • The ISO image filename used to create the OVA from.
  • The .ova file to deploy to the ESXi server

-o | -output

path

Enters the destination output directory of the OVF package, and/or the OVA file.

-n | -name

[ name ]

Creates a unique OVF or OVA name with a different name than the image. If you don’t specify a name, then the default .ova filename is used.

-format

[ ovf | ova | zip ]

Generates the package in the given format(s). Use a comma-separated list for more than one format. The default format is ova .

Virtual Machine Hardware Options

-c | -cpus

cpus

Enters the number of CPUs to provision.

-m | -memory

MB

Enters the amount of memory to provision on the VM. The Cisco CSR 1000V requires 4096 MB.

-ds | -disksize

 

Not supported.

-ns | -nics

nics

Enters the number of Ethernet NICs to provision. The Cisco CSR 1000V requires a minimum of three vNICs.

-ea | -eth_adapter

string

Enters the vNIC Ethernet adapter type. Valid values are the following:

  • VMXNET3

-nw | -network

string

Enters the VM network name for all vNICs or a comma-separated list of one name per vNIC.

Virtual Machine Description Options

-p | -product

string

Enters the description of the product:
Cisco CSR 1000V Cloud Services Router

-v | -vendor

string

Enters the name of the vendor:
Cisco Systems, Inc.

-vs | -version_short

string

Enters the short version string.

-vl | -version_long

string

Enters the long version string.

-pu | -product_url

url

Enters the URL of the product: http://www.cisco.com/en/US/products/ps12559/index.html .

-vu | -vendor_url <URL>

url

Enters the URL of the vendor: http://www.cisco.com.

ESXi/vSphere Deploy Options

-d | -deploy

url

Deploys the OVA to the specified ESXi host.

-u | -username

string

Enters the ESXi login username.

-pw | -password

string

Enters the ESXi login password.

-s | -store

string

Enters the name of the datastore where the OVA will be deployed.

-dm | -diskmode

option

Enters the disk mode type for the VM. Supported options are:

  • thick
  • eagerZeroedThick

-pm | -port_map

list

Enters a comma-separated list of port-map names to use for each VM network from the -network option.

If not specified, the tool will assume this value is the same as the -network value.

-nv | -nooverwrite

 

If this value is set, then it instructs the tool to not overwrite an existing VM with the same name.

-po | -poweron

 

Enters the instruction to automatically power-on the VM.

Note We recommend you do not set the VM to automatically power-on because you need to manually edit the new VM settings for the serial console before powering up the VM on the vSphere Client.

Cisco IOS XE Configuration Options

-iu | -ios_username

string

Enters the Cisco IOS XE username (required for remote login).

-ipw | -ios_password

string

Enters the Cisco IOS XE IOS password (required for remote login).

-epw | -enable_password

string

Enters the Cisco IOS XE IOS enable password.

-ipd | -ip_domain

string

Enters the IP domain name

-hn | -hostname

string

Enters the hostname.

-ip | -ip_address

address/mask

Enters the address/mask for management interface, such as “10.1.1.1/24” or “10.1.1.1 255.255.255.0”. You can also specify the string “dhcp” to use DHCP.

-mg | -mgmt_gateway

address

Enters the default gateway for management VRF. You can also specify the string “dhcp” to use DHCP.

-ssh

 

If set, enables Secure Shell (SSH) login (and disables Telnet).

-http

 

If set, enables the HTTP server.

-https

 

If set, enables the HTTPS server. Required in Cisco IOS Release XE 3.10S if implementing the Cisco CSR 1000V REST API.

-b | -bootstrap

path

Enters the Cisco IOS bootstrap configuration file (such as NVRAM output) to add to bootstrap, for any configurations not covered by the above options.

Editing the Cisco CSR 1000V Basic Properties Using the vSphere GUI

When deploying the OVA template, you have the option to set basic router properties using the vSphere GUI prior to booting, as described in the “Deploying the OVA Template to the VM” section. You can also set custom properties matched to Cisco IOS XE CLI commands. See the “Adding Custom Properties for the Cisco CSR 1000V” section.


Note The functionality described in this chapter works only when using the vSphere GUI to connect to a vCenter server. If connecting directly to a host, these options are not available.


If the VM was manually created from the .iso file, then the vSphere GUI will not provide options to set basic router properties. However, you can still set custom properties as described in the “Adding Custom Properties for the Cisco CSR 1000V” section. If you wish to do so, you will need to add a second virtual CD/DVD drive to the VM for vCenter to pass these properties into the VM.

To edit the vApp options to set basic Cisco CSR 1000V properties, do the following:


Step 1 In the vSphere GUI, select the Options tab.

Step 2 Choose vApp Options > Properties.

See Figure 4-1.

Figure 4-1 vApp Advanced Options for Cisco CSR 1000V

Step 3 Click on the Properties button.

A new window opens that provides access to the properties that can be edited. The properties shown are the basic properties. See Figure 4-2.


Note These properties can also be set using selected steps of the procedure described in the “Deploying the OVA Template to the VM” section.


Figure 4-2 Cisco CSR 1000V Advanced Property Configuration Screen

 

See Table 4-9 and Table 4-10 for the basic Cisco CSR 1000V properties that can be edited in the vSphere vApps GUI.

Step 4 Select the property to be edited and click Edit.

Step 5 Once you have edited the property, click OK to close.


 

Adding Custom Properties for the Cisco CSR 1000V

You can add custom properties to the Cisco CSR 1000V based on Cisco IOS XE CLI commands using the vSphere GUI. You can add these properties either before or after your boot the Cisco CSR 1000V. If you set these custom properties after the Cisco CSR 1000V has booted, you will need to reload the router or power-cycle the VM for the properties settings to take effect.

To edit the vApp options to add custom Cisco CSR 1000V properties, do the following:


Step 1 In the vSphere GUI, select the Options tab.

Step 2 Choose vApp Options > Advanced.

See Figure 4-1.

Step 3 Click on the Properties button.

Step 4 Click New to add a property.

The Edit Property Settings window appears. See Figure 4-3.

Figure 4-3 Edit Property Settings Window

Step 5 Enter the information to create the new custom property based on a Cisco IOS XE CLI command:


Note Before adding a custom property, make sure that the Cisco IOS XE command that it is based on is supported on the Cisco CSR 1000V in your release.


a. (Optional) Enter the label. This is a descriptive string for the property.

b. Enter the class ID as “com.cisco.csr1000v”.

c. Assign the property an ID of “ios-config-xxxx” where xxxx is a sequence number from 0001 to 9999 that determines the order in which the custom properties are applied.

d. (Optional) Enter a description for the property.

e. Enter the property type as “string”. This is the only type supported.

f. Enter the default value as the Cisco IOS XE CLI command the custom property is based on.

Step 6 When finished, click OK.

Figure 4-4 shows an example of the properties screen after the custom property has been added. The added custom property is highlighted in the figure.

Figure 4-4 Example of Custom Property Added

 

Step 7 Click OK.

Step 8 Reboot the Cisco CSR 1000V.

The router must reboot in order for the new or edited properties to take effect.


 

Manually Creating the VM and Installing the Cisco CSR 1000V Software Using the .iso File (VMware ESXi)

Overview of Tasks for Manually Creating the Cisco CSR 1000V VM

Figure 4-5 shows the typical high-level tasks required to manually create the Cisco CSR 1000V VM. The specific procedures, terminology and the order the steps are performed may differ depending on the hypervisor being used. See the sections following for detailed steps for creating the VM.


Note If you manually create the VM and you plan to use the Cisco CSR 1000V REST API, you must configure the HTTPS port using the Cisco IOS XE CLI.


Figure 4-5 Task Overview for Manually Creating the Cisco CSR 1000V VM

Manually Creating the Cisco CSR 1000V VM Using the .iso File (VMware ESXi)

The following steps are performed using VMware VSphere.

While the following procedure provides general guidance for how to deploy the Cisco CSR 1000V, the exact steps that you need to perform may vary depending on the characteristics of your VMware environment and setup. The steps and screen displays in this procedure are based on VMware ESXi 5.0.


Step 1 Download the CSR1000_esxi.iso file from the Cisco CSR 1000V software installation image package and copy it onto the VM Datastore.

Step 2 In the VSphere client, select Create a New Virtual Machine option.

Step 3 Under Configuration, select the option to create a Custom configuration, and click Next.

Step 4 Under Name and Location, specify the name for the VM and click Next.

Step 5 Under Storage, select the datastore to use for the VM. Click Next .

Step 6 Under Virtual Machine Version, select Virtual Machine Version 8. Click Next .


Note The Cisco CSR 1000V is not compatible with ESXi Server versions prior to 5.0.


Step 7 Under Guest Operating System, select Linux and the “Other 2.6x Linux (64-bit) setting” from the drop-down menu. Click Next .

Step 8 Under CPUs, select the following settings:

  • Number of virtual sockets (virtual CPUs)
  • Number of cores per socket

The number of cores per socket should always be set to 1, regardless of the number of virtual sockets selected. For example, a Cisco CSR 1000V with a 4 vCPU configuration should be configured as 4 sockets and 1 core per socket.

See the “Installation Requirements for VMware ESXi” section for the supported number of virtual CPUs and the corresponding required RAM allocation for your release.

Click Next.

Step 9 Under Memory, configure the supported memory size for your Cisco CSR 1000V release. See the “Installation Requirements for VMware ESXi” section for the supported number of virtual CPUs and the corresponding required RAM allocation for your release.

Click Next .

Step 10 Under Network, allocate at least three virtual network interface cards (vNICs).

a. Select the number of vNICs that you want to connect from the drop-down menu.


Note The VMware ESXi 5.0 interface only allows the creation of 4 vNICS during the initial VM creation. You can add more vNICs after the VM is created and the Cisco CSR 1000V is first booted.


b. Add the vNICs.

Select a different network for each vNIC.

Select the adapter type from the drop-down menu. See the requirements table in the “Installation Requirements for VMware ESXi” section for the supported adapter type in your release.

c. Select all vNICs to connect at power-on.

d. Click Next .


Note (Cisco IOS XE Release 3.10S and earlier) The first vNIC added is mapped to the GigabitiEthernet0 management interface on the Cisco CSR 1000V. All remaining vNICs are mapped to the Cisco CSR 1000V network interfaces when the VM is powered on and the router boots for the first time. For more information about how the vNICs on the VM map to the network interfaces on the router, see the “Mapping Cisco CSR 1000V Network Interfaces to VM Network Interfaces” section.



Note You can add vNICs into the VM using vSphere while the Cisco CSR 1000V is running. For more information about adding vNICS to an existing VM, see the vSphere documentation.


Step 11 Under SCSI Controller, select LSI Logic Parallel. Click Next .

Step 12 Under Select a Disk, click Create a new virtual disk.

Step 13 Under Create a Disk, select the following:

  • Capacity: Disk Size

See the “Installation Requirements for VMware ESXi” section for the virtual hard disk size required in your release.

  • Disk Provisioning: select one of the following:

Thick Provision Lazy Zeroed

Thick Provision Eager Zeroed


Note The Thin Provision option is not supported. The Thick Provision Eager Zeroed option takes longer to install but provides better performance.


  • Location: Store with the virtual machine

Click Next.

Step 14 Under Advanced Options, select SCSI (0:0) for the virtual device node.

Step 15 On the Ready to Complete screen, click the Edit the virtual machine settings before completion. Click Continue checkbox.

Step 16 In the Hardware tab, click New CD/DVD Drive .

a. Select the Device Type that the VM will boot from:

Select the Datastore ISO file option to boot from the Cisco CSR 1000V .iso file. Browse to the location of the .iso file on the datastore set in Step 1.

b. In the Device Status field, select the Connect at power on checkbox.

c. Select the Virtual Device Node CD/DVD drive on the host that the VM will boot from.

Step 17 In the Resources tab, click the CPU setting:

Set the Resource Allocation setting to Unlimited.

Step 18 Click OK.

Step 19 Click Finish.

The VM is now configured for the Cisco CSR 1000V and is ready to boot. The Cisco CSR 1000V is booted when the VM is powered on. See the “Booting the Cisco CSR 1000V and Accessing the Console” section.


Note To access and configure the Cisco CSR 1000V from the serial port on the ESXi host instead of the VM console, provision the VM to use this setting before powering on the VM and booting the router. For more information, see the “Booting the Cisco CSR 1000V and Accessing the Console” section.



 

Increasing Performance on VMware ESXi Configurations

You can improve performance on VMware ESXi configurations by performing the following:

  • Disable VMware ESXi power management.

Choose the High Performance setting to disable power management in VMware ESXi 5.0, 5.1 or 5.5. For more information, see the VMware Documentation .