Cisco CSR 1000v Series Software Configuration Manual

Page 1

Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide

Last Modified: 2017-08-18
Americas Headquarters
Cisco Systems, Inc. 170 West Tasman Drive San Jose, CA 95134-1706 USA http://www.cisco.com Tel: 408 526-4000 800 553-NETS (6387) Fax: 408 527-0883
Text Part Number:
Page 2
THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.
THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.
The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB's public domain version of the UNIX operating system. All rights reserved. Copyright©1981, Regents of the University of California.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED AS IS" WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.
IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental.
Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: http://
www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership
relationship between Cisco and any other company. (1110R)
©
2017 Cisco Systems, Inc. All rights reserved.
Page 3

CONTENTS

CHAPTER 1
CHAPTER 2
Preface 1
Preface 1
Objectives 1
Related Documentation 1
Document Conventions 2
Obtaining Documentation and Submitting a Service Request 4
Cisco CSR 1000v Series Cloud Services Router Overview 5
Introduction 5
Benefits of Virtualization Using the Cisco CSR 1000v Series Cloud Services Router 6
Software Configuration and Management Using the Cisco IOS XE CLI 6
Router Interfaces 7
Virtual Machine Requirements 7
Virtual Machines 8
Hypervisor Support 8
Hypervisor VersionsCisco IOS XE Denali 16.3.1 and Later 9
Hypervisor VersionsCisco IOS XE 3.x 9
Hypervisor vNIC Requirements 12
Hypervisor vNIC Requirements for Cisco IOS XE Everest 16.6 13
Hypervisor vNIC Requirements for Cisco IOS XE Everest 16.5 14
Hypervisor vNIC Requirements for Cisco IOS XE Everest 16.4 15
Hypervisor vNIC Requirements for Cisco IOS XE Denali 16.3 17
Hypervisor vNIC Requirements for Cisco IOS XE 3S Releases 18
Supported I/O Modes and Drivers 21
Cisco CSR 1000v and Hypervisor Limitations 24
Cisco CSR 1000v and Hypervisor Limitations for Cisco IOS XE Denali 16.3.1 and
Later 24
Cisco CSR 1000v and Hypervisor Limitations for Cisco IOS XE Denali 16.2 24
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
iii
Page 4
Contents
Cisco CSR 1000v and Hypervisor Limitations for Cisco IOS XE Release
3.12S 24
Cisco CSR 1000v and Hypervisor Limitations for Cisco IOS XE Release
3.10S 25
Cisco CSR 1000v and Hypervisor Limitations for Cisco IOS XE Release 3.9S 25
Server Requirements 26
Cisco Software Licensing (CSL) 27
Evaluation LicensesCisco IOS XE 3.13S and Later, Cisco IOS XE Denali 16.3.1 and
Later 33
Evaluation LicensesCisco IOS XE 3.12S and Earlier 35
Cisco Smart Licensing 35
Differences Between Cisco CSR 1000v Series and ASR 1000 Series 35
Supported Cisco IOS XE Technologies 37
CHAPTER 3
CHAPTER 4
Management Support 48
Managing the Router Using Cisco Configuration Professional 48
Managing the Router Using the Cisco IOS XE REST API 49
Managing the Router Using Cisco Prime Network Services Controller 49
Cisco Unified Computing System (UCS) Products 50
Finding Support Information for Platforms and Cisco Software Images 51
Using Cisco Feature Navigator 51
Using the Software Advisor 51
Using the Software Release Notes 52
Using Cisco IOS XE Software 53
Using Cisco IOS XE Software 53
Finding Command Options 56
NVRAM File Security 60
Installation Overview 61
Introduction 61
Obtaining the Cisco CSR 1000v VM Image 63
Cisco CSR 1000v Installation Files 63
Cisco CSR 1000v Installation Options 64
Guidelines and Limitations 66
ROMMON and the Cisco CSR 1000v 66
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
iv
Page 5
Contents
Where to Go Next 66
CHAPTER 5
Installing the Cisco CSR 1000v in VMware ESXi Environments 69
VMware ESXi Support Information 69
VMware RequirementsCisco IOS XE Everest 16.6 70
Supported VMware Features and Operations 71
General Features (vCenter Server) 71
Operations (for vCenter Server and vSphere Web Client) 72
High Availability 74
Storage Options (for vCenter Server and vSphere Web Client) 75
Deploying the Cisco CSR 1000v OVA to the VM 76
Deploying the Cisco CSR 1000v OVA to the VM 76
Deploying the Cisco CSR 1000v OVA to the VM using vSphere 76
Deploying the Cisco CSR 1000v OVA to the VM using vSphere 76
Restrictions and Requirements 76
Deploying the OVA to the VM 77
Editing the Basic Properties of Cisco CSR 1000v using vSphere 81
Editing the Custom Properties of Cisco CSR 1000v using vSphere 83
Deploying the Cisco CSR 1000v to the VM using COT 84
Deploying the Cisco CSR 1000v OVA to the VM using COT 84
Downloading COT 85
Editing the Basic Properties of Cisco CSR 1000v using COT 85
Editing the Custom Properties of Cisco CSR 1000v using COT 86
cot edit-properties 86
cot inject-config 88
Deploying the Cisco CSR 1000v VM using COT 89
Example 90
Manually Creating the VM and Installing the Cisco CSR 1000v Software Using the .iso File
(VMware ESXi) 90
Overview of Tasks for Manually Creating the Cisco CSR 1000v VM 90
Manually Creating the Cisco CSR 1000v VM Using the .iso File (VMware ESXi) 92
Increasing Performance on VMware ESXi Configurations 94
VMware RequirementsCisco IOS XE Everest 16.5 94
VMware RequirementsCisco IOS XE Everest 16.4 95
VMware RequirementsCisco IOS XE Denali 16.3 96
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
v
Page 6
Contents
VMware RequirementsCisco IOS XE 3.x 97
VMware VM RequirementsCisco IOS XE 3.x 99
Installation RequirementsCisco IOS XE 3.x 101
CHAPTER 6
CHAPTER 7
Installing the Cisco CSR 1000v in Citrix XenServer Environments 105
Citrix XenServer Support Information 105
Installation Requirements for Citrix XenServer: Cisco IOS XE Everest 16.6 106
Manually Creating the Cisco CSR 1000v VM Using the .iso File (Citrix XenServer) 107
Installation Requirements for Citrix XenServer: Cisco IOS XE Everest 16.5 109
Installation Requirements for Citrix XenServer: Cisco IOS XE Everest 16.4 109
Installation Requirements for Citrix XenServer: Cisco IOS XE 16.3 110
Installation Requirements for Citrix XenServer: Cisco IOS XE 3.x 111
Installing the Cisco CSR 1000v in KVM Environments 113
Kernel Virtual Machine Support Information 113
KVM Support on OpenStack 114
Installation Requirements for KVMCisco IOS XE Everest 16.6 114
Creating a Cisco CSR 1000v KVM Instance 115
Creating the Cisco CSR 1000v VM Using the Self-installing .Run Package 115
Installation Procedure 115
Creating the Cisco CSR 1000v VM Using the virt-manager GUI Tool 116
Creating the Cisco CSR 1000v VM Using virt-managerUsing .qcow2 or .iso
Image 116
Creating the Cisco CSR 1000v VM Using virt-managerAdd Serial Port 117
Creating the Cisco CSR 1000v VM Using virt-manager--Add Hard Disk 118
Creating a Bootstrap Day0 Configuration for virt-manager 119
Creating the Cisco CSR 1000v VM Using virt-installUsing .qcow2 Image 119
Creating the Cisco CSR 1000v VM Using virt-installUsing ISO Image 120
Creating a Bootstrap Day0 Configuration for virt-install 122
Creating the Cisco CSR 1000v on OpenStack 122
Selecting a Cisco CSR 1000v Installation Image 122
Creating the Instance Using the OpenStack Command Line Tool 123
Creating the Instance Using the OpenStack Dashboard 124
Troubleshooting for Creating the Instance using OpenStack 125
Bootstrapping the CSR Configuration 126
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
vi
Page 7
Contents
Bootstrap Properties 126
Example ovf-env.xml File 128
Example iosxe_config.txt File 129
Increasing Performance on KVM Configurations 129
Cloning the VM 130
Installation Requirements for KVMCisco IOS XE Everest 16.5 130
Installation Requirements for KVMCisco IOS XE Denali 16.4 131
Installation Requirements for KVMCisco IOS XE Denali 16.3 131
Installation Requirements for KVMCisco IOS XE 3.x 132
CHAPTER 8
Installing the Cisco CSR 1000v in Microsoft Hyper-V Environments 135
Microsoft Hyper-V Support Information 135
Microsoft Hyper-V Limitations 136
Installation Requirements for Microsoft Hyper-VCisco IOS XE Everest 16.6 136
Manually Creating the Cisco CSR 1000v VM using the .iso File (Microsoft Hyper-V) 137
Prerequisites 137
Prerequisites for Manually Creating the CSR 1000v VM using the .iso File 137
Configuring the Server Manager Settings 137
Creating the VM 138
Configuring the VM Settings 139
Launching the VM to Boot the Cisco CSR 1000v 141
Installation Requirements for Microsoft Hyper-VCisco IOS XE Everest 16.5 141
Installation Requirements for Microsoft Hyper-VCisco IOS XE Everest 16.4 142
Installation Requirements for Microsoft Hyper-VCisco IOS XE Denali 16.3.1 143
Installation Requirements for Microsoft Hyper-VCisco IOS XE 3.x 143
CHAPTER 9
Booting the Cisco CSR 1000v and Accessing the Console 145
Booting the Cisco CSR 1000v as the VM 145
Accessing the Cisco CSR 1000v Console 148
Accessing the Cisco CSR 1000v Through the Virtual VGA Console 148
Accessing the Cisco CSR 1000v Through the Virtual Serial Port 148
Introduction to Accessing the Cisco CSR 1000v through the Virtual Serial Port 148
Creating Serial Console Access in VMware ESXi 148
Creating the Serial Console Access in KVM 150
Creating the Serial Console Access in Microsoft Hyper-V 151
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
vii
Page 8
Contents
Opening a Telnet Session to the Cisco CSR 1000v Console on the Virtual Serial
Port 151
Changing the Console Port Access After Installation 152
License Installation 154
CHAPTER 10
Installing Cisco CSR 1000v Licenses 155
Activating Cisco CSR 1000v Licenses 156
Cisco Software Licensing (CSL) 156
Installing CSL Evaluation Licenses for Cisco IOS XE 3.13S and Later 156
Installing CSL Regular Licenses for Cisco IOS XE 3.13S and Later 159
Configuring an Interface for 10 Gbps Maximum Throughput 161
Installing CSL Feature Add-on Licenses for Cisco IOS XE 3.13S and Later 162
Understanding the Cisco CSR 1000v Memory Allocation 162
Installing Memory Add-on License 163
Information About Installing Broadband Feature License 166
Installing Broadband Feature License 167
Troubleshooting CSL License Issues 170
Determining the License Status 170
Migrating Technology Package Licenses to Cisco IOS XE 3.13S 170
Determining the AWS License Type 171
Cisco Smart Licensing 172
viii
Prerequisites for Cisco Smart Licensing 172
Configuring Call Home for Smart Licensing 172
Enabling Cisco Smart Licensing 174
Registering the Router with the Cisco Licensing Cloud 175
Registering the Router with the Cisco Licensing Cloud (CSSM satellite) 176
Re-establishing Connectivity to the Cisco Smart Call Home Server when IPv6 is
Configured 178
Re-establishing ConnectivityMethod 1 178
Re-establishing ConnectivityMethod 2 179
Requesting Cisco Smart License Throughput Level Licenses 180
Requesting Memory Add-on License 182
Requesting Smart License Broadband license 182
Manually Renewing the ID Certificate 183
Manually Renewing the License 183
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
Page 9
Contents
Unregistering a Device from Cisco Smart Licensing 184
Disabling Cisco Smart Licensing 184
License Out-of-Compliance Behavior 185
License Behavior with no Connectivity to the Smart Licensing Server 185
Activating Permanent License Reservation 187
Introduction to Activating Permanent License Reservation 187
Activating Permanent License Reservation 187
Deactivating Permanent License Reservation 188
Troubleshooting Cisco Smart License Issues 189
Determining Device Registration Information 189
Additional show Commands Useful for Troubleshooting 189
Understanding the License-Based Restriction on Aggregate Bandwidth 190
CHAPTER 11
CHAPTER 12
Managing Throughput Notifications 191
Requesting a New Virtual UDI 192
Cisco Software Licensing (IOS XE 3.12 or Earlier) 193
Activating CSL Evaluation Licenses for Cisco IOS XE 3.12S and Earlier 193
Installing CSL Regular Licenses for Cisco IOS XE 3.12S and Earlier 195
Upgrading the Cisco IOS XE Software 199
Prerequisites for the Software Upgrade Process 199
Saving Backup Copies of Your Old System Image and Configuration 200
Using TFTP or Remote Copy Protocol to Copy the System Image into Boot Flash Memory 202
Loading the New System Image from the Cisco IOS XE Software 205
Loading the New System Image from GRUB Mode 208
Saving Backup Copies of Your New System Image and Configuration 210
Rebooting the Cisco CSR 1000v 212
Mapping Cisco CSR 1000v Network Interfaces to VM Network Interfaces 213
CHAPTER 13
Mapping Cisco CSR 1000v Network Interfaces to VM Network Interfaces 213
Mapping the Router Network Interfaces to vNICs 213
Adding and Deleting Network Interfaces on the Cisco CSR 1000v 215
Cisco CSR 1000v Network Interfaces and VM Cloning 216
Mapping Cisco CSR 1000v Network Interfaces with vSwitch Interfaces 217
Accessing and Using GRUB Mode 221
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
ix
Page 10
Contents
About GRUB Mode and the Configuration Register 221
Accessing GRUB Mode 223
Using the GRUB Menu 223
Modifying the Configuration Register (confreg) 224
Changing the Configuration Register Settings 226
Displaying the Configuration Register Settings 227
CHAPTER 14
Configuring Call Home for the Cisco CSR 1000v 229
Prerequisites for Call Home 229
Information About Call Home 230
Benefits of Using Call Home 230
Obtaining Smart Call Home Services 231
Anonymous Reporting 231
How to Configure Call Home 232
How to Configure Call Home 232
Configuring Smart Call Home (Single Command) 232
Configuring and Enabling Smart Call Home 233
Enabling and Disabling Call Home 234
Configuring Contact Information 234
Information About Destination Profiles 236
Creating a New Destination Profile 237
Copying a Destination Profile 239
Setting Profiles to Anonymous Mode 240
Subscribing to Alert Groups 241
Periodic Notification 244
Message Severity Threshold 244
Configuring Snapshot Command List 245
Configuring General email Options 246
Example 248
Specifying Rate Limit for Sending Call Home Messages 249
Specifying HTTP Proxy Server 249
Enabling AAA Authorization to Run IOS Commands for Call Home Messages 250
Configuring Syslog Throttling 251
Configuring Call Home Data Privacy 252
Sending Call Home Communications Manually 253
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
x
Page 11
Contents
Sending Call Home Communications Manually 253
Sending a Call Home Test Message Manually 253
Sending Call Home Alert Group Messages Manually 253
Submitting Call Home Analysis and Report Requests 255
Manually Sending Command Output Message for One Command or a Command List 256
Configuring Diagnostic Signatures 257
Configuring Diagnostic Signatures 257
Prerequisites for Diagnostic Signatures 257
Information About Diagnostic Signatures 258
Diagnostic Signatures Overview 258
Diagnostic Signature Downloading 258
Diagnostic Signature Workflow 259
CHAPTER 15
Diagnostic Signature Events and Actions 259
Diagnostic Signature Event Detection 259
Diagnostic Signature Actions 259
Diagnostic Signature Variables 260
How to Configure Diagnostic Signatures 260
Configuring the Call Home Service for Diagnostic Signatures 260
Configuring Diagnostic Signatures 262
Configuration Examples for Diagnostic Signatures 262
Displaying Call Home Configuration Information 263
Examples 264
Default Settings 268
Alert Group Trigger Events and Commands 268
Message Contents 270
Sample Syslog Alert Notification in XML Format 273
Enabling Management by REST API 275
Introduction 275
Enabling REST API Support During Cisco CSR 1000v OVA Deployment 275
Enabling REST API Support Using the Cisco IOS XE CLI 277
Introduction to REST API Configuration Options 277
Enabling REST API Support 277
Configuring the Shared Management Interface to Support the REST API 279
Configuring the Dual Management Interface to Support the REST API 281
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
xi
Page 12
Contents
Configuring the REST API Local Port and AutoSave Options 283
Configuring HTTPS Support for the REST API Using the Cisco IOS XE CLI 284
Disabling REST API Support 285
Viewing the REST API Container Status 287
CHAPTER 16
CHAPTER 17
CHAPTER 18
Configuring Support for Remote Management by the Cisco Prime Network Services
Controller 289
Configuring the Management Interface to Support Remote Management by the Cisco Prime
Network Services Controller 289
Enabling Remote Management by the Cisco Prime Network Services Controller Host 292
Disabling Remote Management by the Cisco Prime Network Services Controller Host 295
Troubleshooting Cisco CSR 1000v VM Issues 297
Verifying the Cisco CSR 1000v Hardware and VM Requirements 297
Troubleshooting Network Connectivity Issues 297
Troubleshooting VM Performance Issues 298
Rehosting the Cisco CSR 1000v License 299
Voluntarily Rehosting the License to a New VM 299
Obtaining a Rehost License if the System Fails 301
xii
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
Page 13

Preface

CHAPTER 1

Preface

Preface, page 1
Objectives, page 1
Related Documentation, page 1
Document Conventions, page 2
Obtaining Documentation and Submitting a Service Request, page 4
This preface describes the objectives and organization of this document and explains how to find additional information on related products and services. This preface contains the following sections:

Objectives

This document provides an overview of software functionality that is specific to the Cisco CSR 1000v Series Cloud Services Router. It is not intended as a comprehensive guide to all of the software features that can be run using the Cisco CSR 1000v Series router, but only the software aspects that are specific to this router.
For information on general software features that are also available on the Cisco CSR 1000v Series router, see the Cisco IOS XE technology guides for that specific software feature.

Related Documentation

This section refers you to other documentation that also might be useful as you configure your Cisco CSR 1000v router. The documentation listed below is available online. The following documents cover other important information for the Cisco CSR 1000v:
Cisco CSR 1000V Documentation Roadmap, Cisco IOS XE Denali 16.x
Cisco CSR 1000V Series Cloud Services Router Release Notes, Cisco IOS XE 3S
Cisco CSR 1000V Series Cloud Services Router Release Notes for Cisco IOS XE Denali 16.x
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
1
Page 14

Document Conventions

Cisco CSR 1000V Series Cloud Services Router Deployment Guide for Amazon Web Services
Cisco CSR 1000v Deployment Guide for Microsoft Azure
Cisco IOS XE REST API Management Reference Guide
The Cisco IOS XE release documentation home page contains technology guides and feature documentation:
See http://www.cisco.com/en/US/products/ps11174/tsd_products_support_series_home.html
For information on commands, see one of the following resources:
Cisco IOS XE Software Command References
Command Lookup Tool (cisco.com login required)
Document Conventions
This documentation uses the following conventions:
Preface
DescriptionConvention
^ or Ctrl
string
Command syntax descriptions use the following conventions:
bold
italics
The ^ and Ctrl symbols represent the Control key. For example, the key combination ^D or Ctrl-D means hold down the Control key while you press the D key. Keys are indicated in capital letters but are not case sensitive.
A string is a nonquoted set of characters shown in italics. For example, when setting an SNMP community string to public, do not use quotation marks around the string or the string will include the quotation marks.
DescriptionConvention
Bold text indicates commands and keywords that you enter exactly as shown.
Italic text indicates arguments for which you supply values.
[x]
|
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
2
Square brackets enclose an optional element (keyword or argument).
A vertical line indicates a choice within an optional or required set of keywords or arguments.
Page 15
Preface
Document Conventions
DescriptionConvention
[x | y]
Square brackets enclosing keywords or arguments separated by a vertical line indicate an optional choice.
{x | y}
Braces enclosing keywords or arguments separated by a vertical line indicate a required choice.
Nested sets of square brackets or braces indicate optional or required choices within optional or required elements. For example:
DescriptionConvention
[x {y | z}]
Braces and a vertical line within square brackets indicate a required choice within an optional element.
Examples use the following conventions:
DescriptionConvention
screen
bold screen
Examples of information displayed on the screen are set in Courier font.
Examples of text that you must enter are set in Courier bold font.
Note
< >
Angle brackets enclose text that is not printed to the screen, such as passwords.
!
An exclamation point at the beginning of a line indicates a comment line. (Exclamation points are also displayed by the Cisco IOS XE software for certain processes.)
[ ]
Square brackets enclose default responses to system prompts.
The following conventions are used to attract the attention of the reader:
Means reader take note . Notes contain helpful suggestions or references to materials that may not be contained in this manual.
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
3
Page 16

Obtaining Documentation and Submitting a Service Request

Preface
Caution
Means reader be careful . In this situation, you might do something that could result in equipment damage or loss of data.
Obtaining Documentation and Submitting a Service Request
For information about obtaining documentation, submitting a service request, and gathering additional information, see Whats New in Cisco Product Documentation, which lists all new and revised Cisco technical documentation.
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
4
Page 17
CHAPTER 2

Cisco CSR 1000v Series Cloud Services Router Overview

Introduction, page 5
Virtual Machine Requirements, page 7
Cisco Software Licensing (CSL), page 27
Cisco Smart Licensing, page 35
Differences Between Cisco CSR 1000v Series and ASR 1000 Series, page 35
Supported Cisco IOS XE Technologies, page 37
Management Support, page 48
Cisco Unified Computing System (UCS) Products, page 50
Finding Support Information for Platforms and Cisco Software Images, page 51

Introduction

Virtual Router
The Cisco CSR 1000v Cloud Services Router provides a cloud-based virtual router deployed on a virtual machine (VM) instance on x86 server hardware. It supports a subset of Cisco IOS XE software features and technologies, providing Cisco IOS XE security and switching features on a virtualization platform.
When the Cisco CSR 1000v is deployed on a VM, the Cisco IOS XE software functions just as if it were deployed on a traditional Cisco hardware platform.
Features
The Cisco CSR 1000v includes a virtual Route Processor and a virtual Forwarding Processor (FP) as part of its architecture. It supports a subset of Cisco IOS XE software features and technologies.
The Cisco CSR 1000v can provide secure connectivity from an enterprise location, such as a branch office or data center, to the public or private cloud.
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
5
Page 18
Cisco CSR 1000v Series Cloud Services Router Overview

Benefits of Virtualization Using the Cisco CSR 1000v Series Cloud Services Router

The Cisco CSR 1000v is deployed as a virtual machine on a hypervisor. Optionally, you can use a virtual switch (vSwitch), depending on your deployment. You can use selected Cisco equipment for some components. The supported components will depend on your software release.
Benefits of Virtualization Using the Cisco CSR 1000v Series Cloud Services Router
The Cisco CSR 1000v Series uses the benefits of virtualization in the cloud to provide the following:
Hardware independence
Because the Cisco CSR 1000v runs on a virtual machine, it can be supported on any x86 hardware that the virtualization platform supports.
Sharing of resources
The resources used by the Cisco CSR 1000v are managed by the hypervisor, and resources can be shared among VMs. The amount of hardware resources that the VM server allocates to a specific VM can be reallocated to another VM on the server.
Flexibility in deployment
You can easily move a VM from one server to another. Thus, you can move the Cisco CSR 1000v from a server in one physical location to a server in another physical location without moving any hardware resources.

Software Configuration and Management Using the Cisco IOS XE CLI

You can perform software configuration and management of the Cisco CSR 1000v using the following methods:
Provision a serial port in the VM and connect to access the Cisco IOS XE CLI commands.
Use the virtual VGA console or the console on the virtual serial port to access the Cisco IOS XE CLI
commands.
Note
A serial port can be used to manage a Cisco CSR 1000v VM only if the underlying hypervisor supports associating a serial port with a VM. For example, the Citrix XenServer environment does not support serial port association. See your hypervisor documentation for details.
Use remote SSH/Telnet to access the Cisco IOS XE CLI commands.
The Cisco CSR 1000v also supports management and configuration using the following products:
Cisco IOS XE REST API
Cisco Prime Network Services Controller
For more information, see "Management Support", from Managing the Router Using Cisco Configuration
Professional, on page 48 onwards.
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
6
Page 19
Cisco CSR 1000v Series Cloud Services Router Overview

Router Interfaces

The Cisco CSR 1000v router interfaces perform the same functionality as those on hardware-based Cisco routers. The Cisco CSR 1000v interfaces function as follows:
Interfaces are logically named as the Gigabit Ethernet (GE) interfaces.
The available interface numbering depends on the Cisco CSR 1000v version.
(Cisco IOS XE Release 3.11S and later, and Denali 16.2 and later) The interface numbering is as follows:
Interface port numbering is from 1 and up to the number of interfaces supported.
GigabitEthernet interface 0 is no longer supported beginning with this release.
You can designate any interface as the management interface. You can change the management
interface when deploying the OVA template on first-time installation.
(Cisco IOS XE Release 3.10S and earlier) The interface numbering is as follows:
Router Interfaces
Interface port numbering is from 0 and up to the number of interfaces supported.
Gigabit Ethernet interface 0 is reserved for the management interface used for obtaining the licenses
and upgrading software.
At first boot, the Cisco CSR 1000v router interfaces are mapped to the vNIC interfaces on the VM based
on the vNIC enumeration to the Cisco CSR 1000v; on subsequent boot, the Cisco CSR 1000v router interfaces are mapped to the vNIC MAC address
Caution
If upgrading to Cisco IOS XE Release 3.11S from an earlier release, we recommend you update your configuration to remove the GigabitEthernet 0 management interface before upgrading. Because the GigabitEthernet 0 interface is no longer supported beginning with Cisco IOS XE Release 3.11S, you will receive system errors if the upgraded configuration includes this interface.
For more information, see the “Mapping Cisco CSR 1000v Network Interfaces to VM Network Interfaces”
section on page 11-1 .

Virtual Machine Requirements

The Cisco CSR 1000v runs only on a virtual machine. This section describes the virtual machine requirements for the router.
Virtual Machines, on page 8
Hypervisor Support, on page 8
Server Requirements, on page 26
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
7
Page 20

Virtual Machines

Virtual Machines
A virtual machine (VM) is a software implementation of a computing environment in which an operating system (OS) or program can be installed and run. The VM typically emulates a physical computing environment, but requests for CPU, memory, hard disk, network and other hardware resources are managed by a virtualization layer which translates these requests to the underlying physical hardware.
You can deploy an Open Virtualization Archive (OVA) file. The OVA file package simplifies the process of deploying a VM by providing a complete definition of the parameters and resource allocation requirements for the new VM.
An OVA file consists of a descriptor (.ovf) file, a storage (.vmdk) file and a manifest (.mf) file.
ovf file—Descriptor file which is an xml file with extension .ovf which consists of all the metadata about
vmdk file—File format that encodes a single virtual disk from a VM.
mf file—Optional file that stores the SHA key generated during packaging.
Cisco CSR 1000v Series Cloud Services Router Overview
the package. It encodes all the product details, virtual hardware requirements and licensing.
You can also install the Cisco CSR 1000v using an .iso file and manually create the VM in the hypervisor.
For more information, see the “Installation Overview” section on page 3-1 .

Hypervisor Support

A hypervisor enables multiple operating systems to share a single hardware host machine. While each operating system appears to have the dedicated use of the host's processor, memory, and other resources; the hypervisor controls and allocates only needed resources to each operating system and ensures that the operating systems (VMs) do not disrupt each other.
Supported Hypervisor Types
Installation of the Cisco CSR 1000v is supported on selected Type 1 (native, bare metal) hypervisors. Installation is not supported on Type 2 (hosted) hypervisors, such as VMware Fusion, VMware Player, or Virtual Box.
Amazon Cloud Marketplace
The Cisco CSR 1000v is available in the Amazon Cloud Marketplace. (For use with Cisco IOS XE Release
3.11S through 3.16.2S, and Cisco IOS XE Denali 16.3.1 and later.) For more information, see the Cisco CSR
1000V Series Cloud Services Router Deployment Guide for Amazon Web Services.
Microsoft Azure Marketplace
The Cisco CSR 1000v is available in the Microsoft Azure Marketplace . For more information, see the Cisco
CSR 1000V Series Cloud Services Router Deployment Guide for Microsoft Azure .
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
8
Page 21
Cisco CSR 1000v Series Cloud Services Router Overview
Hypervisor VersionsCisco IOS XE Denali 16.3.1 and Later
The following hypervisors/versions are supported by Cisco CSR 1000v on Cisco IOS XE Denali 16.3.1 and later. If you are using other versions of Cisco IOS XE, see Hypervisor VersionsCisco IOS XE 3.x, on page
9.
VMware ESXi
Server 6.0 update2 (instance running vm11)recommended. F.ully tested and meets performance benchmarks
Server 5.5 update3 (instance running vm10)
Although 5.5 update 3 is supported for Cisco IOS XE Denali 16.3.1 and later, we recommend using VMware ESXi Server 6.0 update 2 instead.
Kernel Based Virtual Machine (KVM)
RHEL 7.2recommended
RHEL 7.1
Citrix XenServer
Hypervisor Support
6.5recommended
6.2
Microsoft Hyper-V
Windows Server 2012-R2, Hyper-V Mgr 6.3.9600.16384recommended
Amazon Web Services
C4 and T2 instance typesrecommended
C3 instance typessupported (in Cisco IOS XE 3.11 to IOS XE 3.17)
See "Amazon Web Services" in Hypervisor Support, on page 8.
Microsoft Azure
Standard D2 and Standard D3recommended
Standard D4supported
See "Microsoft Azure" in Hypervisor Support, on page 8.
Hypervisor VersionsCisco IOS XE 3.x
The following table lists the supported hypervisor versions for older software releases (Cisco IOS XE 3.x).
Note
For recent hypervisor versions see the Hypervisor VersionsCisco IOS XE Denali 16.3.1 and Later, on
page 9.
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
9
Page 22
Hypervisor Support
Table 1: Support Matrix for Hypervisor Versions
Cisco CSR 1000v Series Cloud Services Router Overview
XE Release
Citrix XenServerVMwareESXiCisco CSR 1000v IOS
Microsoft Hyper-VKernel Based Virtual
Machine (KVM)
Amazon Web Services
Not supportedNot supportedNot supportedNot supported5.03.9S
6.0.25.05.13.10S Linux KVM
Not supportedNot supported
based on Red Hat Enterprise Linux 6.3
Red Hat
1
Enterprise Virtualization
3.1
6.025.05.13.11S Linux KVM
SupportedNot supported
based on Red Hat Enterprise Linux 6.31
Red Hat
Enterprise Virtualization
3.1
3.12S
Ubuntu
12.04.03 LTS Server 64 Bits
3
6.15.05.15.5 Linux KVM
based on Red
2
SupportedWindows Server
2012 R2
Hat Enterprise Linux 6.31
Ubuntu
12.04.03 LTS Server 64 Bits 2
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
10
Page 23
Cisco CSR 1000v Series Cloud Services Router Overview
Hypervisor Support
XE Release
3.13S
3.14S
3.15S
Citrix XenServerVMwareESXiCisco CSR 1000v IOS
Microsoft Hyper-VKernel Based Virtual
Machine (KVM)
4
6.25.05.15.5 Linux KVM
based on Red
2012 R2
Amazon Web Services
SupportedWindows Server
Hat Enterprise Linux 6.31
Ubuntu
12.04.03 LTS Server 64 Bits 2
5
6.25.05.15.5 Linux KVM
based on Red
2012 R2
SupportedWindows Server
Hat Enterprise Linux 6.5
Ubuntu 14.04
LTS Server 64 Bits 2
6
6.25.05.15.5 Linux KVM
based on Red
2012 R2
SupportedWindows Server
Hat Enterprise Linux 6.6
3.16S
Ubuntu 14.04
LTS Server 64 Bits 2
8
6.25.05.15.576.0 Linux KVM
based on Red
Windows Server 2012 R2
Hat Enterprise
Supported until Cisco IOS XE
3.16.2
Linux 6.6
Ubuntu 14.04
LTS Server 64 Bits 2
6.25.05.15.56.03.17S Linux KVM
based on Red Hat Enterprise Linux 7.1
Ubuntu 14.04
2012 R2
9
Not supportedWindows Server
LTS Server 64 Bits 2
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
11
Page 24
Hypervisor Support
Cisco CSR 1000v Series Cloud Services Router Overview
Citrix XenServerVMwareESXiCisco CSR 1000v IOS
XE Release
Machine (KVM)
For later versions of Cisco IOS XE, see:
Hypervisor VersionsCisco IOS XE Denali
16.3.1 and Later, on page 9
1
Requires Kernel version 2.6.3.2 and QEMU 0.12.
2
Requires QEMU-x86_64 version 1.0 (qemu-kvm-1.0), Copyright (c) 2003-2008 Fabrice Bellard.
3
VMware ESXi 5.5 update 3 is not supported on Cisco IOS XE 3.12S..
4
VMware ESXi 5.5 update 3 is not supported on Cisco IOS XE 3.13S..
5
VMware ESXi 5.5 update 3 is not supported on Cisco IOS XE 3.14S.
6
VMware ESXi 5.5 update 3 is not supported on Cisco IOS XE 3.15S.
7
VMware ESXi 5.5 update 3 is supported on Cisco IOS XE 3.16.1S and later.
8
VMware ESXi 6.0 supported on Cisco IOS XE 3.16.1S and later (and 3.17S and later).
9
Requires Kernel version 3.10.0 and QEMU 1.5.3.
Hypervisor features may differ depending on the hypervisor, and not all features in a given hypervisor version may be supported. The hypervisor versions listed are those officially tested and supported by the Cisco CSR 1000v. See the following sections for more information:
Microsoft Hyper-VKernel Based Virtual
Amazon Web Services
For information about deploying the Cisco CSR 1000v in an Amazon Web Services environment, see theNote
Note
For information about deploying the Cisco CSR 1000v in a Microsoft Azure environment, see the Cisco
CSR 1000V Deployment Guide for Microsoft Azure .
Hypervisor vNIC Requirements
Depending on the Cisco CSR 1000v release version, each of the hypervisors supports different virtual network interface card (vNIC) types. The Cisco CSR 1000v also supports a different maximum number of vNICs depending on the hypervisor. Some versions and hypervisors also support the ability to add and remove vNICs without powering down the VM (vNIC Hot Add/Remove).
The VMXNET3, VIF and Virtio NIC types listed in the table are para-virtualized NICs.
See also Supported I/O Modes and Drivers, on page 21.
The following sections list the supported vNICs and the minimum and maximum number of vNICs supported for each VM instance. Choose a section, depending on the release of Cisco IOS XE which you are using.
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
12
Page 25
Cisco CSR 1000v Series Cloud Services Router Overview
Hypervisor vNIC Requirements for Cisco IOS XE Everest 16.6
Hypervisor Support
ValuevNIC Requirements for VMware ESXi
NIC Types Supported
VMXNET3ixgbe(Intel 10Gb PCI Express NIC Driver) ixgbef
10Max. number of vNICs per VM instance
YesvNIC Hot Add Support (Intel 10Gb PCI Express NIC Driver)
NovNIC Hot Remove Support (Intel 10Gb PCI Express NIC Driver)
YesSingle Root I/O virtualization (SR-IOV) Support
ValuevNIC Requirements for Citrix XenServer
VIF-netfront(pmap)NIC Types Supported
7Max. number of vNICs per VM instance
YesvNIC Hot Add Support
NovNIC Hot Remove Support
YesSingle Root I/O virtualization (SR-IOV) Support
ValuevNIC Requirements for KVM
Virtio, ixgbevf, ixgbbeNIC Types Supported
26Max. number of vNICs per VM instance
YesvNIC Hot Add Support
NovNIC Hot Remove Support
YesSingle Root I/O virtualization (SR-IOV) Support
ValuevNIC Requirements for Microsoft Hyper-V
NetVSCNIC Types Supported
8Max. number of vNICs per VM instance
NovNIC Hot Add Support
NovNIC Hot Remove Support
NoSingle Root I/O virtualization (SR-IOV) Support
ValuevNIC Requirements for Microsoft Azure
NetVSCNIC Types Supported
8Max. number of vNICs per VM instance
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
13
Page 26
Hypervisor Support
Cisco CSR 1000v Series Cloud Services Router Overview
ValuevNIC Requirements for Microsoft Azure
NovNIC Hot Add Support
NovNIC Hot Remove Support
NoSingle Root I/O virtualization (SR-IOV) Support
ValuevNIC Requirements for Amazon Web Services (AWS)
VIF-netfront(pmap), ixgbevfNIC Types Supported
Max. number of vNICs per VM instance
Hypervisor vNIC Requirements for Cisco IOS XE Everest 16.5
NIC Types Supported
8 (See http://docs.aws.amazon.com/AWSEC2/
latest/UserGuide/ using-eni.html#AvailableIpPerENI)
NovNIC Hot Add Support
NovNIC Hot Remove Support
NoSingle Root I/O virtualization (SR-IOV) Support
ValuevNIC Requirements for VMware ESXi
VMXNET3ixgbe(Intel 10Gb PCI Express NIC Driver) ixgbef
10Max. number of vNICs per VM instance
YesvNIC Hot Add Support (Intel 10Gb PCI Express NIC Driver)
NovNIC Hot Remove Support (Intel 10Gb PCI Express NIC Driver)
YesSingle Root I/O virtualization (SR-IOV) Support
ValuevNIC Requirements for Citrix XenServer
VIF-netfront(pmap)NIC Types Supported
7Max. number of vNICs per VM instance
YesvNIC Hot Add Support
NovNIC Hot Remove Support
YesSingle Root I/O virtualization (SR-IOV) Support
ValuevNIC Requirements for KVM
Virtio, ixgbevf, ixgbbeNIC Types Supported
26Max. number of vNICs per VM instance
YesvNIC Hot Add Support
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
14
Page 27
Cisco CSR 1000v Series Cloud Services Router Overview
Hypervisor Support
ValuevNIC Requirements for KVM
NovNIC Hot Remove Support
YesSingle Root I/O virtualization (SR-IOV) Support
ValuevNIC Requirements for Microsoft Hyper-V
NetVSCNIC Types Supported
8Max. number of vNICs per VM instance
NovNIC Hot Add Support
NovNIC Hot Remove Support
NoSingle Root I/O virtualization (SR-IOV) Support
ValuevNIC Requirements for Microsoft Azure
Max. number of vNICs per VM instance
Hypervisor vNIC Requirements for Cisco IOS XE Everest 16.4
NetVSCNIC Types Supported
8Max. number of vNICs per VM instance
NovNIC Hot Add Support
NovNIC Hot Remove Support
NoSingle Root I/O virtualization (SR-IOV) Support
ValuevNIC Requirements for Amazon Web Services (AWS)
VIF-netfront(pmap), ixgbevfNIC Types Supported
8 (See http://docs.aws.amazon.com/AWSEC2/
latest/UserGuide/ using-eni.html#AvailableIpPerENI)
NovNIC Hot Add Support
NovNIC Hot Remove Support
NoSingle Root I/O virtualization (SR-IOV) Support
NIC Types Supported
ValuevNIC Requirements for VMware ESXi
VMXNET3ixgbe(Intel 10Gb PCI Express NIC Driver) ixgbef
10Max. number of vNICs per VM instance
YesvNIC Hot Add Support (Intel 10Gb PCI Express NIC Driver)
NovNIC Hot Remove Support (Intel 10Gb PCI Express NIC Driver)
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
15
Page 28
Hypervisor Support
Cisco CSR 1000v Series Cloud Services Router Overview
ValuevNIC Requirements for VMware ESXi
YesSingle Root I/O virtualization (SR-IOV) Support
ValuevNIC Requirements for Citrix XenServer
VIF-netfront(pmap)NIC Types Supported
7Max. number of vNICs per VM instance
YesvNIC Hot Add Support
NovNIC Hot Remove Support
YesSingle Root I/O virtualization (SR-IOV) Support
ValuevNIC Requirements for KVM
Virtio, ixgbevf, ixgbbeNIC Types Supported
26Max. number of vNICs per VM instance
YesvNIC Hot Add Support
NovNIC Hot Remove Support
YesSingle Root I/O virtualization (SR-IOV) Support
ValuevNIC Requirements for Microsoft Hyper-V
NetVSCNIC Types Supported
8Max. number of vNICs per VM instance
NovNIC Hot Add Support
NovNIC Hot Remove Support
NoSingle Root I/O virtualization (SR-IOV) Support
ValuevNIC Requirements for Microsoft Azure
NetVSCNIC Types Supported
4Max. number of vNICs per VM instance
NovNIC Hot Add Support
NovNIC Hot Remove Support
NoSingle Root I/O virtualization (SR-IOV) Support
ValuevNIC Requirements for Amazon Web Services (AWS)
VIF-netfront(pmap), ixgbevfNIC Types Supported
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
16
Page 29
Cisco CSR 1000v Series Cloud Services Router Overview
Hypervisor Support
ValuevNIC Requirements for Amazon Web Services (AWS)
Max. number of vNICs per VM instance
Hypervisor vNIC Requirements for Cisco IOS XE Denali 16.3
NIC Types Supported
8 (See http://docs.aws.amazon.com/AWSEC2/
latest/UserGuide/ using-eni.html#AvailableIpPerENI)
NovNIC Hot Add Support
NovNIC Hot Remove Support
NoSingle Root I/O virtualization (SR-IOV) Support
ValuevNIC Requirements for VMware ESXi
VMXNET3ixgbe (Intel 10Gb PCI Express NIC Driver) ixgbef
10Max. number of vNICs per VM instance
YesvNIC Hot Add Support (Intel 10Gb PCI Express NIC Driver)
NovNIC Hot Remove Support (Intel 10Gb PCI Express NIC Driver)
YesSingle Root I/O virtualization (SR-IOV) Support
ValuevNIC Requirements for Citrix XenServer
VIF-netfront(pmap)NIC Types Supported
7Max. number of vNICs per VM instance
YesvNIC Hot Add Support
NovNIC Hot Remove Support
YesSingle Root I/O virtualization (SR-IOV) Support
ValuevNIC Requirements for KVM
Virtio, ixgbevf, ixgbbeNIC Types Supported
26Max. number of vNICs per VM instance
YesvNIC Hot Add Support
NovNIC Hot Remove Support
YesSingle Root I/O virtualization (SR-IOV) Support
ValuevNIC Requirements for Microsoft Hyper-V
NetVSCNIC Types Supported
8Max. number of vNICs per VM instance
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
17
Page 30
Hypervisor Support
Cisco CSR 1000v Series Cloud Services Router Overview
ValuevNIC Requirements for Microsoft Hyper-V
NovNIC Hot Add Support
NovNIC Hot Remove Support
NoSingle Root I/O virtualization (SR-IOV) Support
ValuevNIC Requirements for Microsoft Azure
NetVSCNIC Types Supported
4Max. number of vNICs per VM instance
NovNIC Hot Add Support
NovNIC Hot Remove Support
NoSingle Root I/O virtualization (SR-IOV) Support
Max. number of vNICs per VM instance
Hypervisor vNIC Requirements for Cisco IOS XE 3S Releases
Table 2: Cisco CSR 1000v vNIC Support for Cisco IOS XE 3S Releases
Release:
VMware ESXi
Supported
ValuevNIC Requirements for Amazon Web Services (AWS)
VIF-netfront(pmap), ixgbevfNIC Types Supported
8 (See http://docs.aws.amazon.com/AWSEC2/
latest/UserGuide/ using-eni.html#AvailableIpPerENI)
NovNIC Hot Add Support
NovNIC Hot Remove Support
NoSingle Root I/O virtualization (SR-IOV) Support
3.16S, 3.17S3.13S, 3.14S, 3.15S3.12S3.10S, 3.11S3.9SCisco IOS XE
VMXNET3VMXNET3VMXNET3NIC Types
VMXNET3ixgbe (Intel 10Gb PCI Express NIC Driver)
VMXNET3ixgbe Intel 10Gb PCI Express NIC Driverenic
vNICs per VM instance
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
18
1010101010Max. number of
Page 31
Cisco CSR 1000v Series Cloud Services Router Overview
Release:
Add/Remove Support(Prior to release 3.15S, vNIC Hot Remove requires reloading the Cisco CSR 1000v. This is applicable only when using the VMXNET3 driver.)
Hypervisor Support
3.16S, 3.17S3.13S, 3.14S, 3.15S3.12S3.10S, 3.11S3.9SCisco IOS XE
YesYesYesYesNovNIC Hot
Single Root I/O virtualization (SR-IOV) Support
Citrix XenServer
NIC Types Supported
Max. number of vNICs per VM instance
vNIC Hot Add/Remove Support
Single Root I/O virtualization (SR-IOV) Support
KVM
VIFVIF
VIFixgbevf
ixgbe (Intel 10Gb PCI Express NIC Driver)
NoNoNo
VIFixgbevf
ixgbe (Intel 10Gb PCI Express NIC Driver)
7777
NoNoNoNo
YesYesYes (from release
3.12.1S)
NIC Types Supported
Max. number of vNICs per VM instance
VirtioVirtio
Virtio
ixgbevf
ixgbe (Intel 10Gb PCI Express NIC Driver)
Virtio
ixgbevf
ixgbe (Intel 10Gb PCI Express NIC Driver)enic
26262610
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
19
Page 32
Hypervisor Support
Release:
Cisco CSR 1000v Series Cloud Services Router Overview
3.16S, 3.17S3.13S, 3.14S, 3.15S3.12S3.10S, 3.11S3.9SCisco IOS XE
vNIC Hot Add/Remove Support
(Prior to release
3.15S, vNIC Hot Remove requires reloading the Cisco CSR 1000v. This is applicable only when using the Virtio driver)
Single Root I/O virtualization (SR-IOV) Support
Microsoft Hyper-V
YesYesYesYes
Yes (from release
3.12.1S)
Yes (Requires the host hardware to support the Intel VT-d or AMD IOMMU specification. SR-IOV is not supported with Virtual LANs (VLANs))
Yes(Requires the host hardware to support the Intel VT-d or AMD IOMMU specification. SR-IOV is not supported with Virtual LANs (VLANs))
NIC Types Supported
Max. number of vNICs per VM instance
vNIC Hot Add/Remove Support
Single Root I/O virtualization (SR-IOV) Support
Amazon Web Services
NIC Types Supported
3.11 and later), aws-vif(pmap)
HV NetVSCHV NetVSCHV NetVSC
333
NoNoNo
NoNoNo
aws-vif(pmap)aws-vif(pmap)(For Cisco IOS XE
(Up until Cisco IOS XE 3.16.2) aws-vif(pmap), aws-ixgbevf(SRIOV)
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
20
Page 33
Cisco CSR 1000v Series Cloud Services Router Overview
Release:
Hypervisor Support
3.16S, 3.17S3.13S, 3.14S, 3.15S3.12S3.10S, 3.11S3.9SCisco IOS XE
Max. number of vNICs per VM instance
vNIC Hot Add/Remove Support
virtualization (SR-IOV) Support
The vNIC requirements for later versions of Cisco IOS XE are in sections such as:
Hypervisor vNIC Requirements for Cisco IOS XE Everest 16.4, on page 15
(For Cisco IOS XE
3.11 to 3.16.2,
number depends on instance type. See
AWS User Guide
NoNoNoNo
YesYesYesNoNoSingle Root I/O
Supported I/O Modes and Drivers
The Cisco CSR 1000v operates within a virtualization environment. Data I/O involves communication between one or more vNICs of the guest OS in which the CSR is operating, and the physical NIC accessed by the host OS.
Modes
Beginning with Cisco IOS XE 3.16S and also including Cisco IOS XE Denali 16.3.1 and later, the Cisco CSR 1000v supports several modes of communication between the vNICs and the physical hardware:
Para Virtual
PCI Passthrough
Single Root I/O Virtualization (SR-IOV)
Cisco Virtual Machine Fabric Extender (VM-FEX)
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
21
Page 34
Hypervisor Support
Cisco CSR 1000v Series Cloud Services Router Overview
The figure below, "Cisco CSR 1000v I/O Routing Between vNIC of Guest OS and Hardware NIC of Host", shows the I/O routing options.
Figure 1: Cisco CSR 1000v I/O Routing Between vNIC of Guest OS and Hardware NIC of Host
Drivers
The following table indicates the drivers required to support various I/O modes.
Table 3: Driver Support for I/O Modes
Para Virtual
PCI Passthrough
SR-IOV
Cisco CSR1000v DriversMode
VMXNET3 (ESXi)
Virtio (KVM)
VIF-netfront (Xen)
NetVSC (Hyper-V)
ixgbe (for Intel 10 gig NIC)
enic (for Cisco VIC)
ixgbevf
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
22
Page 35
Cisco CSR 1000v Series Cloud Services Router Overview
Hypervisor Support
Cisco CSR1000v DriversMode
VM-FEX
Only applicable to Cisco VIC
There are 2 modes:
ESXi DirectPath IO: VMXNET3
PCI Passthrough: enic
Note
PCI Passthrough: enic is not supported in Cisco IOS XE Denali 16.3.1 and higher.
Note: For releases Cisco IOS XE 3.16 or later, and Cisco IOS XE Denali 16.3 or later, the boot up process may take a long time (5 minutes) when using passthrough drivers. This is due to performing DHCP during a PXE boot. This issue can be resolved (as mentioned in resolved caveat CSCvd45286) by turning off rom bar for Ethernet PCI devices in the Cisco CSR 1000v xml file; for example:
<hostdev mode='subsystem' type='pci' managed='yes'>
<source>
<address domain='0x0000' bus='0x85' slot='0x00' function='0x0'/> </source> <rom bar='off'/> <------ Add this line to xml file <address type='pci' domain='0x0000' bus='0x00' slot='0x07' function='0x0'/>
</hostdev>
Limitations
The following table describes the limitations that apply to I/O modes.
Table 4: I/O Mode Limitations
PCI passthrough (enic)
LimitationsMode/Driver
Interoperability with another NIC: If enic is connected to
other NIC (for example, Intel NIC) and then that NIC is used for other CSR VM (Para virtual or Passthrough), traffic will not pass through if enic is configured with VLAN.
If a VLAN is configured, the other NIC receives a VLAN
packet with VLAN id of 0.
Jumbo packet support: In this release, jumbo packet (MTU
> 1518) is not supported.
CDP is not supported.
HSRP standby cannot ping the HSRP group address
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
23
Page 36
Hypervisor Support
Cisco CSR 1000v Series Cloud Services Router Overview
LimitationsMode/Driver
SR-IOV (ixgbevf)
VM-FEX ESXi DirectPath IO (VMXNET3)
MTU change: (Intel limitation) First change the VF MTU
on the host PF using the ip link set command. Then change the corresponding interface MTU on the VM. Otherwise, no traffic will pass. (Intel limitation)
MAC address change: After changing the MAC address, it
is necessary to change the MAC address of the VF on the host PF using the ip link set command. Otherwise, no traffic will pass. (Intel limitation.)
Maximum VLANs: The maximum number of VLANs
supported on PF is 64. Together, all VFs can have a total of 64 VLANs. (Intel limitation.)
Maximum Multicast filtering: Intel VF supports registering
a maximum of 30 multicast addresses. (Intel limitation.)
Layer2 Learning: Intel SRIOV VF does not support
promiscuous mode, so Layer 2 functionality, such as EVC, does not work. (Intel limitation.)
VLAN is not supported in high-performance mode.
Cisco CSR 1000v and Hypervisor Limitations
This section describes performance limitations due to how the Cisco CSR 1000v integrates with supported hypervisors.
Cisco CSR 1000v and Hypervisor Limitations for Cisco IOS XE Denali 16.3.1 and Later
In these releases, the Cisco CSR 1000v does not support the hot removal of interfaces and does not have the ability to modify vNIC MTU.
Cisco CSR 1000v and Hypervisor Limitations for Cisco IOS XE Denali 16.2
Cisco IOS XE Denali 16.3.1 and later is recommended instead of Cisco IOS XE Denali 16.2.Note
Cisco CSR 1000v and Hypervisor Limitations for Cisco IOS XE Release 3.12S
When the Cisco CSR 1000v is installed on Microsoft Hyper-V, the interface numbers can change after
Microsoft Hyper-V fails over to a new server, or restarts after a live migration.
If the server is set to perform ungraceful failover, there is no workaround.
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
24
Page 37
Cisco CSR 1000v Series Cloud Services Router Overview
If the server is set to perform graceful failover or restart, enter the clear platform software vnic-if
nvtable command before executing the failover or restart.
This issue is not seen if the maximum number of interfaces is configured.
When the Cisco CSR 1000v is installed on Microsoft Hyper-V, if you want to configure a VLAN, you
must configure the VLAN interfaces on Microsoft Hyper-V using the Hyper-V Power Shell CLI.
When the Cisco CSR 1000v is installed on Microsoft Hyper-V and an NSF-based virtual hard disk is
used, if there is a network connectivity issue between the Cisco CSR 1000v and the NSF server, the Cisco CSR 1000v is unable to use the virtual hard disk even if the network connection is restored. You must reboot the Cisco CSR 1000v to restore access to the virtual hard disk.
The Microsoft Hyper-V GUI only allows one VLAN to be specified for a Virtual Machine interface.
This limits deployments where multiple VLANS for a Virtual Machine interface are used.
When the MAC address of a Cisco CSR1000v interface is changed from the address assigned by the
hypervisor, then traffic to and from external devices is unsuccessful. This occurs even when MAC address spoofing is enabled on the Microsoft Hyper-V vSwitch. Operation of protocols like FHRP, CLNS, and Etherchannel that use their own MAC address may be unsuccessful.
Hypervisor Support
In Microsoft Hyper-V environments, the following limitations apply when the Windows Power Shell
CLI is used to configure VLANs:
The power shell CLI commands must be reapplied each time the Cisco CSR1000v is reloaded.
When a large AllowedVlanIdList is configured, only lower numbered VLANS may successfully
pass traffic. For example, when the following Power Shell CLI command is used:
Set-VMNetworkAdapterVlan -VMName dr-vm-6-1 -Trunk -AllowedVlanIdList 1-2000 -NativeVlanId 0
Only VLANS lower than 300 may successfully pass traffic.
Cisco CSR 1000v and Hypervisor Limitations for Cisco IOS XE Release 3.10S
Configuring Network Based Application Recognition (NBAR), or Application Visibility and Control
(AVC) support on the Cisco CSR 1000v requires a minimum of 4GB of DRAM on the VM, even when using the one vCPU configuration on the VM.
On the Cisco CSR 1000v, all the NICs are logically named as the Gigabit Ethernet interface. The Cisco
CSR 1000v does support the 10G IXGBE vNIC in passthrough mode; but that interface also is also logically named as a Gigabit Ethernet interface. Note that with emulated devices like VMXNET3/PV/VIRTIO from the hypervisor, the Cisco CSR 1000v is not aware of the underlying interfaces. The vSwitch may be connected to a 10-GB physical NIC or 1-GB physical NICs or multiple NICs (with NIC teaming on the hypervisor) as well.
The Cisco CSR 1000v supports an MTU range from 1500 to 9216 bytes. However, the maximum MTU
supported on your hypervisor version may be lower. The MTU value configured on the Cisco CSR 1000v should not exceed the maximum MTU value supported on the hypervisor.
Cisco CSR 1000v and Hypervisor Limitations for Cisco IOS XE Release 3.9S
The following are the Cisco CSR 1000v and VMware ESXi limitations for Cisco IOS XE Release 3.9S:
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
25
Page 38

Server Requirements

The Cisco CSR 1000v interface bandwidth defaults to 1 GB, irrespective of the hypervisors physical
NIC bandwidth. The routing protocols (OSPF, EIGRP) use the Cisco CSR 1000v interface bandwidth values for calculating the costs, not the physical NIC bandwidth.
When a Cisco CSR 1000v interface is directly connected to a physical router, and that physical routers
connecting interface goes down, the change is not reflected on the Cisco CSR 1000v. This is because the Cisco CSR 1000v is actually connected to the hypervisors vSwitch and the vSwitch uplink port is connected to the physical interface of the router. This behavior is expected.
The Cisco CSR 1000v provides an MTU range from 1500 to 9216 bytes. However, ESXi 5.0 supports
only a maximum value of 9000 bytes.
Server Requirements
The server and processor requirements are different depending on the Cisco CSR 1000v release.
Table 5: Server Requirements
Cisco CSR 1000v Series Cloud Services Router Overview
Cisco IOS XE Release 3.9S
Cisco IOS XE Denali 16.3.1 and later
For more information, see the release notes: http://www.cisco.com/c/en/us/support/routers/
cloud-services-router-1000v-series/products-release-notes-list.html.
(For Cisco IOS XE Release 3.9S) the Cisco CSR 1000v uses instructions not supported on Intel pre-Nehalem generation processors. The existence of the required Nehalem or later processor instruction set is determined at boot time. If the required instructions are not present, the following message is displayed:
%IOSXEBOOT-4-BOOT_HALT: (rp/0): Halted boot due to missing CPU feature
requirement(s)
(For Cisco IOS XE Denali 16.3 and 16.4) the Cisco CSR 1000v uses instructions supported on Intel Core 2 and later generation processors including Streaming SIMD: SSE, SSE2, SSE3 and SSSE3. The existence of the required instruction set is not verified and the deployment of the Cisco CSR 1000v in an environment that does not meet these processor requirements may result in random system reloads.
processors
64-bit Intel Core2 and later generation processors with VT extensions and support for Streaming SIMD instructions: SSE, SSE2, SSE3 and SSSE3.
AMDIntelCisco CSR 1000v Release
Not supportedIntel Nehalem and later generation
64-bit processors with VT extensions64-bit processors with VT extensionsCisco IOS XE Release 3.10S and later
The equivalent of 64-bit Intel Core2 and later generation processors with VT extensions and support for Streaming SIMD instructions: SSE, SSE2, SSE3 and SSSE3.
(For Cisco IOS XE Everest 16.5 and later) the Cisco CSR 1000v uses instructions supported on Intel Core 2 and later generation processors including Streaming SIMD SSE, SSE2, SSE3 and SSSE3. The existence of the required streaming SIMD instruction sets is determined at boot time. If the required instructions are not present, a message similar to following is displayed:
%CPPDRV-3-FATAL_CPU_FEATURE: F0: cpp_driver: CPP0: CPU lacks feature
(Supplemental Streaming SIMD Extensions 3 (SSSE3)). Packet forwarding disabled.
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
26
Page 39
Cisco CSR 1000v Series Cloud Services Router Overview

Cisco Software Licensing (CSL)

The Cisco CSR 1000v supports two types of license: Cisco Software Licensing and Cisco Smart Licensing. This section summarizes Cisco Software Licensing. For more details of both licensing methods, see Activating
Cisco CSR 1000v Licenses, on page 156
The Cisco CSR 1000v supports the following types of Cisco Software License, depending on the software release:
Perpetual and subscription term licenses for 1, 3, and 5 years based on the following attributes:
(Cisco IOS XE 3.13S and later, and Denali 16.3.1 and later) Technology packages: IPBase,
Security, AX and APPX (supported by Cisco Smart Licensing beginning with Cisco IOS XE
3.15S)
Maximum supported throughput level for the AX package: 10, 25, 50, 100, 250, or 500 Mbps; 1
or 2.5 Gbps
Maximum supported throughput level for the Security and APPX packages: 10, 25, 50, 100, 250,
or 500 Mbps; 1, 2.5, or 5 Gbps
Cisco Software Licensing (CSL)
Note
Maximum supported throughput level for the IPBase package: 10, 25, 50, 100, 250, or 500 Mbps;
1, 2.5, 5, or 10 Gbps
Memory upgrade licenses (selected technology packages and throughput levels only)
Evaluation licenses (see Evaluation Licenses—Cisco IOS XE 3.13S and Later, Cisco IOS XE Denali
16.3.1 and Later, on page 33).
Three legacy technology packagesStandard, Advanced, and Premiumwere replaced in Cisco IOS XE Release 3.13 with the IPBase, Security, and AX technology packages.
The following table lists the available license types for your release.
Table 6: Cisco CSR 1000v Software Licenses
License TermLicense TypeCisco CSR 1000v Version
Cisco IOS XE Release 3.9S
(Legacy)
Base subscription technology package licenses (Standard, Advanced, and Premium) for the following throughput maximums: 10 Mbps, 25 Mbps, 50 Mbps
1, 3, and 5 years
60-day evaluation license
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
27
Page 40
Cisco Software Licensing (CSL)
Cisco CSR 1000v Series Cloud Services Router Overview
License TermLicense TypeCisco CSR 1000v Version
Cisco IOS XE Releases 3.10S,
3.11S
(Legacy)
Base subscription Standard technology package licenses for the following throughput maximums: 10 Mbps, 50 Mbps, 100 Mbps, 250 Mbps, 500 Mbps, 1 Gbps
Base subscription Advanced and Premium technology package licenses for the following throughput maximums: 10 Mbps, 50 Mbps, 100 Mbps, 250 Mbps
Feature Add-on License:
License to add 8 GB of
memory with route reflector support.
This is available for the Premium or AX packages only. The additional memory is allocated to IOSD processes on the router only. The memory upgrade license does not add available memory on the VM.
Note
Selected licenses are available through a Cisco service representative only.
1 and 3 years
Perpetual
60-day evaluation license
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
28
Page 41
Cisco CSR 1000v Series Cloud Services Router Overview
Cisco Software Licensing (CSL)
License TermLicense TypeCisco CSR 1000v Version
Cisco IOS XE Release 3.12S
(Legacy)
Base subscription Standard technology package licenses for the following throughput maximums: 10 Mbps, 50 Mbps, 100 Mbps, 250 Mbps, 500 Mbps, 1 Gbps, 2.5 Gbps, 5 Gbps
Base subscription Advanced and Premium technology package licenses for the following throughput maximums: 10 Mbps, 50 Mbps, 100 Mbps, 250 Mbps, 1 Gbps
Feature Add-on License:
License to add 8 GB of
memory with route reflector support.
This is available for the Premium or AX packages only. The additional memory is allocated to IOSD processes on the router only. The memory upgrade license does not add available memory on the VM.
Selected licenses are only available through a Cisco service representative.
1 and 3 years
Perpetual
60-day evaluation license
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
29
Page 42
Cisco Software Licensing (CSL)
Cisco CSR 1000v Series Cloud Services Router Overview
License TermLicense TypeCisco CSR 1000v Version
Cisco IOS XE Release 3.12.1S
New technology package licenses are supported:
IPBase package license, with
the same feature set as the Standard package
Security package license,
with the same feature set as the Advanced package
AX package license, with the
same feature set as the Premium package
We recommend using these technology packages for compatibility with future releases. All technology packages support the same throughput maximums as feature sets in earlier releases.
1 and 3 years
Perpetual
60-day evaluation license
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
30
Page 43
Cisco CSR 1000v Series Cloud Services Router Overview
Cisco Software Licensing (CSL)
License TermLicense TypeCisco CSR 1000v Version
Cisco IOS XE Releases 3.13S,
3.14S, 3.15S, 3.16S, 3.17
Cisco IOS XE Denali 16.3.1 and later
Base subscription IPBase technology package licenses for the following maximum throughputs: 10 Mbps, 50 Mbps, 100 Mbps, 250 Mbps, 500 Mbps, 1 Gbps, 2.5 Gbps, 5 Gbps, 10 Gbps.
(IPBase replaces the Standard package.)
Base subscription Security technology package licenses for the following maximum throughputs: 10, 25, 50, 100, 250, or 500 Mbps; 1, 2.5, or 5 Gbps
(Security replaces the Advanced package.)
Base subscription AX technology package licenses for the following maximum throughputs: 10, 25, 50, 100, 250, or 500 Mbps; 1 or 2.5 Gbps
(AX replaces the Premium package.)
Base subscription Application Experience (APPX) technology package licenses for the following maximum throughputs: 10 Mbps, 50 Mbps, 100 Mbps, 250 Mbps, 500 Mbps, 1 Gbps, 2.5 Gbps, 5 Gbps
1 and 3 years
Perpetual
60-day evaluation license
available through Cisco licensing portal
The supported performance indicates the maximum throughput supported by the Cisco CSR 1000v for the license. If the throughput exceeds the supported performance, the router may experience dropped packets and you will receive notification that the supported performance has been exceeded. The Cisco CSR 1000v uses a performance limiter to regulate the throughput level. For example this applies when using 10 Gbps throughput as part of the IPBase technology package licenses. For more information, see the Configuring an Interface
for 10 Gbps Maximum Throughput, on page 161.
If additional performance is required, an additional license for a separate Cisco CSR 1000v VM must be purchased. The Cisco CSR 1000v supports only one router instance per VM.
The Cisco CSR 1000v software licenses operate as follows:
Each software license can be used for only one VM.
You can install more than one license on a VM, but the multiple licenses can only apply to that VM.
Similar to Cisco hardware products, the software license is node-locked to the unique device identifier
(UDI) of that product. The Cisco CSR 1000v generates a Virtual UDI (vUDI) when first installed on
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
31
Page 44
Cisco Software Licensing (CSL)
the VM, and licenses are node-locked to that vUDI. One license per VM instance is required. Instances that are cloned from a repository must generate a new vUDI.
Cisco CSR 1000v Series Cloud Services Router Overview
Note
When you clone the Cisco CSR 1000v, you will automatically get a new vUDI, and all the licenses from the original VM should be removed.
You must purchase and install a new technology package license if you want to upgrade or downgrade
the technology level. For example, if you have a Premium technology package license and you want to downgrade to the Standard technology package, you must purchase a new Standard technology package license.
In Cisco IOS XE Release 3.10S, the default license will not enable advanced IPsec features and MPLS.
The Cisco CSR 1000v does not provide or support Right-to-Use performance licenses.
You will receive warning notices that the subscription term license will expire beginning eight weeks
before license expiration.
The licenses must be activated in order for the Cisco CSR 1000v network ports to provide the supported throughput.
When the Cisco CSR 1000v is first booted, the router operates in evaluation mode, and provides limited feature support and limited throughput. To obtain the full feature support and throughput provided by your license, you must install the license using the license install command. The configuration requirements depend on the release version:
In Cisco IOS XE 3.12S and earlier, to access the features supported in your license, you must enter the
license boot level command and set it to the level supported by your license. The Cisco CSR 1000v must be rebooted for the new license level to take effect and to have the new license applied.
In Cisco IOS XE 3.13S and later, the Cisco CSR 1000v first boots up in the AX technology mode by
default, so all features in this package are supported. Installing an AX technology license applies the AX license immediately, and the throughput is increased to the maximum throughput of the installed license. Rebooting the router is not required.
If you install a different technology license (IPBase, Security or APPX), the corresponding license boot level command setting is automatically added to the running configuration, but you must reboot the router for the new license technology level to take effect and to have the license applied.
The installed license technology package must match the routers current technology level (as shown with the show version command). If the license package does not match the current license level the throughput is limited to 100kbps. To apply a license belonging to a different technology package level, you must update the license level using the license boot level command and reboot the Cisco CSR 1000v for the new license level to take effect.
If the throughput license expires or becomes invalid, the maximum throughput of the router reverts to 2.5 Mbps (Cisco IOS XE 3.12S and earlier), or 100 Kbps (Cisco IOS XE 3.13S and later), upon reload.
The subscription term begins on the day the license is issued.
For more information about license activation, see the Activating Cisco CSR 1000v Licenses, on page 156.
If you rehost the Cisco CSR 1000v to a VM on another server, the following rules apply:
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
32
Page 45
Cisco CSR 1000v Series Cloud Services Router Overview

Evaluation LicensesCisco IOS XE 3.13S and Later, Cisco IOS XE Denali 16.3.1 and Later

You must purchase a new rehost software license that lasts for the period remaining on the original
license.
If the original license was renewed, the rehosted software license will last for the period remaining on
the renewed license.
You have a 60-day grace period to remove the software license from the original server hardware and
activate it on the rehosted server hardware.
The Cisco CSR 1000v also supports Cisco License Manager and Cisco License Call Home. For more information about the standard Cisco IOS XE software activation procedure, and information about Cisco License Manager and Cisco License Call Home, see the Software Activation Configuration Guide, Cisco IOS
XE Release 3S .
Evaluation LicensesCisco IOS XE 3.13S and Later, Cisco IOS XE Denali 16.3.1 and Later
Evaluation licenses are available to try out Cisco CSR 1000v features. Evaluation licenses are obtained differently depending on the IOS XE release version. This section describes versions Cisco IOS XE 3.13S or later and Cisco IOS XE Denali 16.3.1 or later.
Default
Beginning with the Cisco IOS XE 3.13S release, the CSR 1000v boots by default with the following features:
AX technology package features
100 Kbps maximum throughput
Evaluation License Options
Evaluation licenses valid for 60 days are available at the Cisco licensing portal.
http:/www.cisco.com/go/license
The evaluation license options enable test driving additional technology packages and higher throughputs. (The throughputs available through evaluation licenses are the highest supported throughput levels for the package type.)
IPBase Technology package, 10 Gbps
SEC Technology package, 5 Gbps
APP Technology package, 5 Gbps
AX Technology package, 2.5 Gbps
1000 broadband sessions
12 GB memory upgrade
Testing a Lower Maximum Throughput
To test a lower throughput license type not listed here, use the platform hardware throughput level MB <throughput> command to set the throughput to a supported level below that provided by the installed license.
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
33
Page 46
Evaluation LicensesCisco IOS XE 3.13S and Later, Cisco IOS XE Denali 16.3.1 and Later
This has the same effect as installing a license for that throughput level. For example, on a CSR 1000v with a 5 Gbps license installed, the following command sets the throughput level to 250 Mbps:
platform hardware throughput level MB 250
The supported throughput levels are: 10 Mbps, 50 Mbps, 100 Mbps, 250 Mbps, 500 Mbps, 1 Gbps, 2.5 Gbps, 5 Gbps, 10 Gbps
For any additional questions, contact your Cisco sales representative.
Obtaining an Evaluation License from the Cisco Licensing Portal
To obtain a 60-day evaluation license for the Cisco CSR 1000v, follow the instructions below.
When the 60-day evaluation license expires, the maximum throughput becomes limited to 100 Kbps upon reload. For more information, see “Installing CSL Evaluation Licenses for Cisco IOS XE 3.13S and Later”
section on page 9-7 .
These instructions are subject to change.Note
Cisco CSR 1000v Series Cloud Services Router Overview
SUMMARY STEPS
DETAILED STEPS
Step 1
Step 2 Step 3
Step 4
Step 5
Navigate to www.cisco.com/go/license and log in.
Navigate to the Product License Registration Portal.
On the Product License Registration page, select Continue to Product License Registration.
Click Get Other Licensesand select Demo and Evaluationfrom the dropdown menu.
In the Product Family section, select Routers & Switches.In the Product section, select Cisco Cloud Services Router 1000v.Click Next.
Step 6
Select the desired license type. Enter the UDI Serial number, then click Next to generate the license. You can display the UDI Serial number on your router by entering the show license udi command.
1.
Navigate to www.cisco.com/go/license and log in.
Navigate to the Product License Registration Portal.
2.
3.
On the Product License Registration page, select Continue to Product License Registration.
4.
Click Get Other Licensesand select Demo and Evaluationfrom the dropdown menu.
5.
In the Product Family section, select Routers & Switches.In the Product section, select Cisco Cloud Services Router 1000v.Click Next.
Select the desired license type. Enter the UDI Serial number, then click Next to generate the license. You
6.
can display the UDI Serial number on your router by entering the show license udi command.
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
34
Page 47
Cisco CSR 1000v Series Cloud Services Router Overview

Evaluation LicensesCisco IOS XE 3.12S and Earlier

Evaluation LicensesCisco IOS XE 3.12S and Earlier
Evaluation licenses are available to try out Cisco CSR 1000v features. Evaluation licenses are obtained differently depending on the IOS XE release version. This section describes versions Cisco IOS XE 3.12S or earlier.
Prior to the Cisco IOS XE 3.13S release, the Cisco CSR 1000v came bundled with a 60-day evaluation license included with the software image, providing:
Premium technology package features
50 Mbps maximum throughput
The license is activated by entering the license boot level command and rebooting the router.
When the 60-day evaluation license expires, the maximum throughput reverts to 2.5 Mbps and to the Standard feature set upon reload. For more information, see the “Activating CSL Evaluation Licenses for Cisco IOS
XE 3.12S and Earliersection on page 9-2 .

Cisco Smart Licensing

The Cisco CSR 1000v supports two types of license: Cisco Software Licensing and Cisco Smart Licensing. This section summarizes Cisco Smart Licensing. For details, see Cisco Smart Licensing, on page 172
Beginning with Cisco IOS XE Release 3.15S, the Cisco CSR 1000v supports activation using Cisco Smart Licensing (CSL). To use Cisco Smart Licensing, first configure the Call Home feature and obtain Cisco Smart Call Home Services. For details, see Cisco Smart Licensing, on page 172.
The Cisco CSR 1000v supports the following license types (Cisco IOS XE 3.14S and later):
IPBase
Security
AX
APPX

Differences Between Cisco CSR 1000v Series and ASR 1000 Series

Unlike traditional Cisco hardware router platforms, the Cisco CSR 1000V Series is a virtual router that runs independently on an x86 machine. As a result, the Cisco CSR 1000v Series architecture has unique attributes that differentiate it from hardware-based router platforms.
For example, the table below lists a comparison of some key areas where the Cisco CSR 1000v Series differs from the Cisco ASR 1000 series routers.
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
35
Page 48
Differences Between Cisco CSR 1000v Series and ASR 1000 Series
Table 7: Cisco CSR 1000v Series Architecture Differences with Cisco ASR 1000 Series Routers
Cisco CSR 1000v Series Cloud Services Router Overview
Cisco CSR 1000v SeriesCisco ASR 1000 SeriesFeature
Physical resources
Supported.Hard Disk
Managed by architecture of the hardware platform.
Physical serial port.Console types supported
Supported.ROMMON
The Cisco CSR 1000v does not include a hard disk. The software image is stored on bootflash only (8 GB).
Managed by the hypervisor. Physical resources are shared among VMs.
Virtual VGA console
Virtual serial port network
option (virtual terminal server)
Named pipe option
Physical serial port on the
ESXi or KVM host
The Cisco CSR 1000v does not include ROMMON, but uses GRUB to provide similar but more limited functionality.
Port numbering
ISSU
Subpackage upgrades
documentation .
Upgrades (ISSU).
Supports installation of subpackages for specific SPAs and SIP SPAs.
Supported.Dynamic addition/deletion of ports
Not supported.Supported.Break Signal
Gigabit Ethernet x ports only.See the Cisco ASR1000
Not supported.Supports In-Service Software
Subpackages not supported. The Cisco CSR 1000v does not support SPAs.
Not supported.Supported.Diagnostic mode
Supported. (Requires reload of the VM.)
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
36
Page 49
Cisco CSR 1000v Series Cloud Services Router Overview

Supported Cisco IOS XE Technologies

The Cisco CSR 1000v Series Cloud Services Router supports selected Cisco IOS XE technologies. The Cisco CSR 1000v supports a more limited set of functionality compared to other router platforms.
The table below lists the major Cisco IOS XE technologies the Cisco CSR 1000V supports. Technologies not listed are not currently supported on the Cisco CSR 1000v. Not all features in a given technology may be supported. To verify support for specific features, use Cisco Feature Navigator. For more information, see the Using Cisco Feature Navigator, on page 51.
The information listed in this table applies only if using the Cisco IOS XE CLI. Support for Cisco IOS XE technologies is more limited in the following scenarios:
When deploying the Cisco CSR 1000v on Amazon Web Services (AWS):
For more information, see:
Cisco CSR 1000V Series Cloud Services Router Deployment Guide for Amazon Web Services .
The following white paper includes information about the high availability solution: Deploying the Cisco
Cloud Services Router 1000V Series in Amazon AWS: Design and Implementation Guide
Supported Cisco IOS XE Technologies
Note
When deploying the Cisco CSR 1000v on Microsoft Azure:
For more information, see:
Cisco CSR 1000v Deployment Guide for Microsoft Azure
When using the Cisco IOS XE REST API to manage the Cisco CSR 1000v:
For more information, see Enabling Management by REST API, on page 275. For information about Cisco IOS XE technologies supported by the REST API, see the Cisco IOS XE REST API Management
Reference Guide .
When using Cisco Prime Network Services Controller (PNSC) to remotely manage the Cisco CSR
1000v:
For more information on features supported, see Configuring Support for Remote Management by the
Cisco Prime Network Services Controller, on page 289.
The IPBase, Security, and AX license technology packages became available beginning with Cisco IOS XE 3.12.1.
Table 8: Cisco IOS XE Technologies Supported on the Cisco CSR 1000v Cloud Services Router
Technologies Supported
Technology Package Licenses Supported in Cisco IOS XE Releases
3.12S and Earlier (Legacy)
Technology Package Licenses Supported in Cisco IOS XE Releases
3.13S and Later, and Denali 16.3.1 and Later
See the Following Documentation:
IP:
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
37
Page 50
Supported Cisco IOS XE Technologies
Cisco CSR 1000v Series Cloud Services Router Overview
Technologies Supported
IPv4 Routing
IPv4 Fragmentation
and Reassembly
IPv6 Forwarding
IPv6 Routing
Technology Package Licenses Supported in Cisco IOS XE Releases
3.12S and Earlier (Legacy)
Standard
Advanced
Premium
Standard
Advanced
Premium
Technology Package Licenses Supported in Cisco IOS XE Releases
3.13S and Later, and Denali 16.3.1 and Later
IPBase
Security
AX
APPX
IPBase
Security
AX
APPX
See the Following Documentation:
IP Addressing
Configuration Guide Library, Cisco IOS XE Release 3S
Cisco IOS IP
Addressing Services Command Reference
IPv6 Configuration
Guide Library, Cisco IOS XE Release 3S
Cisco IOS IPv6
Command Reference
Generic Routing
Encapsulation (GRE)
LISP
Standard
Advanced
Premium
Premium
IPBase
Security
AX
APPX
AX
APPX
Interface and
Hardware Component Configuration Guide, Cisco IOS XE Release 3S
Cisco IOS Interface
and Hardware Component Command Reference
IP Routing: LISP
Configuration Guide, Cisco IOS XE Release 3S
Cisco IOS IP
Routing: LISP Command Reference
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
38
Page 51
Cisco CSR 1000v Series Cloud Services Router Overview
Supported Cisco IOS XE Technologies
Technologies Supported
Connectionless
mode network service (CLNS)
Basic Routing:
BGP
Technology Package Licenses Supported in Cisco IOS XE Releases
3.12S and Earlier (Legacy)
Standard
Advanced
Premium
Technology Package Licenses Supported in Cisco IOS XE Releases
3.13S and Later, and Denali 16.3.1 and Later
IPBase
Security
AX
APPX
IPBase
Security
AX
APPX
See the Following Documentation:
ISO CLNS
Configuration Guide, Cisco IOS XE Release 3S
IP Routing: BGP
Configuration Guide, Cisco IOS XE Release 3S
Cisco IOS IP
Routing: BGP Command Reference
EIGRP
ISIS
Standard
Advanced
Premium
Standard
Advanced
Premium
IPBase
Security
AX
APPX
IPBase
Security
AX
APPX
IP Routing: EIGRP
Configuration Guide, Cisco IOS XE Release 3S
Cisco IOS IP
Routing: EIGRP Command Reference
IP Routing: ISIS
Configuration Guide, Cisco IOS XE Release 3S
Cisco IOS IP
Routing: ISIS Command Reference
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
39
Page 52
Supported Cisco IOS XE Technologies
Cisco CSR 1000v Series Cloud Services Router Overview
Technologies Supported
OSPF
Performance
Routing
Technology Package Licenses Supported in Cisco IOS XE Releases
3.12S and Earlier (Legacy)
Standard
Advanced
Premium
Standard
Advanced
Premium
Technology Package Licenses Supported in Cisco IOS XE Releases
3.13S and Later, and Denali 16.3.1 and Later
IPBase
Security
AX
APPX
IPBase
Security
AX
APPX
See the Following Documentation:
IP Routing: OSPF
Configuration Guide, Cisco IOS XE Release 3S
Cisco IOS IP
Routing: OSPF Command Reference
Performance
Routing Configuration Guide, Cisco IOS XE Release 3S
Cisco IOS
Performance Routing Command Reference
IP Multicast:
IGMP
PIM
IP Switching:
Advanced
Premium
Advanced
Premium
Security
AX
Security
AX
IP Multicast: IGMP
Configuration Guide, Cisco IOS XE Release 3S
Cisco IOS IP
Multicast Command Reference
IP Multicast: PIM
Configuration Guide, Cisco IOS XE Release 3S
Cisco IOS IP
Multicast Command Reference
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
40
Page 53
Cisco CSR 1000v Series Cloud Services Router Overview
Supported Cisco IOS XE Technologies
Technologies Supported
Cisco Express
Forwarding
Wide Area Networking:
OTV
(Supported beginning in Cisco IOS XE 3.10S.)
Technology Package Licenses Supported in Cisco IOS XE Releases
3.12S and Earlier (Legacy)
Standard
Advanced
Premium
Premium
Technology Package Licenses Supported in Cisco IOS XE Releases
3.13S and Later, and Denali 16.3.1 and Later
IPBase
Security
AX
APPX
AX
APPX
See the Following Documentation:
IP Switching Cisco
Express Forwarding Configuration Guide, Cisco IOS XE Release 3S
Cisco IOS IP
Switching Command Reference
Wide-Area
Networking Configuration Guide: Overlay Transport Virtualization, Cisco IOS XE Release 3S
VxLAN
(Supported beginning in Cisco IOS XE 3.11S.)
WCCPv2
Premium
Premium
AX
APPX
AX
APPX
Cisco IOS
Wide-Area Networking Command Reference
Cisco CSR 1000V
VxLAN Support
IP Application
Services Configuration Guide, Cisco IOS XE Release 3S
Cisco IOS IP
Application Services Command Reference
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
41
Page 54
Supported Cisco IOS XE Technologies
Cisco CSR 1000v Series Cloud Services Router Overview
Technologies Supported
VPN:
IPsec VPN
DMVPN
Easy VPN
Technology Package Licenses Supported in Cisco IOS XE Releases
3.12S and Earlier (Legacy)
Advanced
Premium
Advanced
Premium
Advanced
Premium
Technology Package Licenses Supported in Cisco IOS XE Releases
3.13S and Later, and Denali 16.3.1 and Later
Security
AX
Security
AX
Security
AX
See the Following Documentation:
Secure Connectivity
Configuration Guide Library, Cisco IOS XE Release 3S
Dynamic Multipoint
VPN Configuration Guide, Cisco IOS XE Release 3S
Easy VPN
Configuration Guide, Cisco IOS XE Release 3S
FlexVPN
GETVPN
(Supported beginning in Cisco IOS XE Everest
16.6.1)
SSL VPN
(Supported beginning in Cisco IOS XE 3.12.1S.)
MPLS:
Advanced
Premium
Advanced
Premium
Advanced
Premium
Security
AX
Security
AX
Security
AX
FlexVPN and
Internet Key Exchange Version 2 Configuration Guide, Cisco IOS XE Release 3S
Cisco Group
Encrypted Transport VPN Configuration Guide, Cisco IOS XE Release 3S
SSL VPN
Configuration Guide, Cisco IOS XE Release 3S
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
42
Page 55
Cisco CSR 1000v Series Cloud Services Router Overview
Supported Cisco IOS XE Technologies
Technologies Supported
MPLS
EoMPLS
VRF
Technology Package Licenses Supported in Cisco IOS XE Releases
3.12S and Earlier (Legacy)
Premium
Premium
Advanced
Premium
Technology Package Licenses Supported in Cisco IOS XE Releases
3.13S and Later, and Denali 16.3.1 and Later
APPX
AX
APPX
AX
IPBase
See the Following Documentation:
See the Multiprotocol Label Switching (MPLS) guides in the CSR 1000v
Configuration Guides.
See the
Multiprotocol Label Switching (MPLS) guides in the CSR 1000v
Configuration Guides.
MPLS: Layer 3
VPNs Configuration Guide, Cisco IOS XE Release 3S
VPLS
(Supported beginning in Cisco IOS XE 3.10S.)
Network Management:
Premium
APPX
AX
Cisco IOS
Multiprotocol Label Switching Command Reference
MPLS Layer 2
VPNs Configuration Guide, Cisco IOS XE Release 3S
Cisco IOS
Multiprotocol Label Switching Command Reference
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
43
Page 56
Supported Cisco IOS XE Technologies
Cisco CSR 1000v Series Cloud Services Router Overview
Technologies Supported
SNMP
Flexible NetFlow
Technology Package Licenses Supported in Cisco IOS XE Releases
3.12S and Earlier (Legacy)
Standard
Advanced
Premium
Standard
Advanced
Premium
Technology Package Licenses Supported in Cisco IOS XE Releases
3.13S and Later, and Denali 16.3.1 and Later
IPBase
Security
AX
APPX
IPBase
Security
AX
APPX
See the Following Documentation:
SNMP
Configuration Guide, Cisco IOS XE Release 3S
Cisco IOS Network
Management Command Reference
Flexible NetFlow
Configuration Guide, Cisco IOS XE Release 3S
Cisco IOS Flexible
NetFlow Command Reference
Secure Shell (SSH)
QoS:
QoS
Services:
Standard
Advanced
Premium
Standard (Cisco
IOS XE 3.12S)
Advanced(Cisco
IOS XE 3.10S and later)
Premium
IPBase
Security
AX
APPX
IPBase
Security
AX
APPX
Secure Shell
Configuration Guide, Cisco IOS XE Release 3S
Quality of Service
Solutions Configuration Guide Library, Cisco IOS XE Release 3S
Cisco IOS Quality
of Service Solutions Command Reference
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
44
Page 57
Cisco CSR 1000v Series Cloud Services Router Overview
Supported Cisco IOS XE Technologies
Technologies Supported
NAT
Access Control:
AAA
Technology Package Licenses Supported in Cisco IOS XE Releases
3.12S and Earlier (Legacy)
Standard
Advanced
Premium
Standard
Advanced
Premium
Technology Package Licenses Supported in Cisco IOS XE Releases
3.13S and Later, and Denali 16.3.1 and Later
IPBase
Security
AX
APPX
IPBase
Security
AX
APPX
See the Following Documentation:
IP Addressing:
NAT Configuration Guide, Cisco IOS XE Release 3S
Cisco IOS IP
Addressing Services Command Reference
Authentication
Authorization and Accounting Configuration Guide, Cisco IOS XE Release 3S
Access Control
Lists
IP SLA
RADIUS
Standard
Advanced
Premium
Premium
Standard
Advanced
Premium
IPBase
Security
AX
APPX
AX
APPX
IPBase
Security
AX
APPX
Securing the Data
Plane Configuration Guide Library, Cisco IOS XE Release 3S
IP SLAs
Configuration Guide, Cisco IOS XE Release 3S
Cisco IOS IP SLAs
Command Reference
RADIUS
Configuration Guide Cisco IOS XE Release 3S
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
45
Page 58
Supported Cisco IOS XE Technologies
Cisco CSR 1000v Series Cloud Services Router Overview
Technologies Supported
TACACS+
Layer3 Firewall
Technology Package Licenses Supported in Cisco IOS XE Releases
3.12S and Earlier (Legacy)
Standard
Advanced
Premium
Advanced
Premium
Technology Package Licenses Supported in Cisco IOS XE Releases
3.13S and Later, and Denali 16.3.1 and Later
IPBase
Security
AX
APPX
Security
AX
See the Following Documentation:
TACACS+
Configuration Guide Cisco IOS XE Release 3S
MPLS: Layer 3
VPNs Configuration Guide, Cisco IOS XE Release 3S
Cisco IOS
Multiprotocol Label Switching Command Reference
Zone-Based
Firewall
Zone-Based
Firewall Multi-tenancy for Cloud Integrated Security Solution
(Supported starting with Cisco IOS XE Denali 16.4.1.)
Application Services:
Advanced
Premium
NA
Security
AX
Advanced
Premium
Security
Configuration Guide: Zone-Based Policy Firewall, Cisco IOS XE Release 3S
Cloud Integrated
Security Solution Guide
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
46
Page 59
Cisco CSR 1000v Series Cloud Services Router Overview
Supported Cisco IOS XE Technologies
Technologies Supported
Application
Visibility and Control (AVC)
NBAR2
Technology Package Licenses Supported in Cisco IOS XE Releases
3.12S and Earlier (Legacy)
Premium
Premium
Technology Package Licenses Supported in Cisco IOS XE Releases
3.13S and Later, and Denali 16.3.1 and Later
AX
APPX
AX
APPX
See the Following Documentation:
Application
Visibility and Control Configuration Guide
NBAR Protocol
Library, Cisco IOS XE Release 3S
QoS: NBAR
Configuration Guide, Cisco IOS XE Release 3S
Download the NBAR2 protocol pack for your release on the Cisco CSR 1000V software download page. For more information, see the
NBAR2 Protocol Library.
Broadband:
Broadband Network
Gateway
(Supported beginning in Cisco IOS XE 3.13S.)
NA
APPX
(Requires broadband add-on feature license (L-CSR-BB-1K=).
Broadband Access
Aggregation and DSL Configuration Guide, Cisco IOS XE Release 3S
Cisco IOS
Broadband Access Aggregation and DSL Command Reference
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
47
Page 60

Management Support

Cisco CSR 1000v Series Cloud Services Router Overview
Technologies Supported
Intelligent Services
Gateway
(Supported beginning in Cisco IOS XE 3.13S.)
Redundancy:
HSRP
Technology Package Licenses Supported in Cisco IOS XE Releases
3.12S and Earlier (Legacy)
NA
Standard
Advanced
Premium
Technology Package Licenses Supported in Cisco IOS XE Releases
3.13S and Later, and Denali 16.3.1 and Later
APPX
(Requires broadband add-on feature license (L-CSR-BB-1K=).
IPBase
Security
AX
APPX
See the Following Documentation:
Intelligent Services
Gateway Configuration Guide, Cisco IOS XE Release 3S
Cisco IOS
Intelligent Services Gateway Command Reference
First Hop
Redundancy Protocols Configuration Guide, Cisco IOS XE Release 3S
WAAS:
Integrated
AppNav-XE
Premium
AX
APPX
Management Support

Managing the Router Using Cisco Configuration Professional

Beginning with Cisco IOS XE Release 3.12S, the Cisco CSR 1000v supports managing the router using Cisco Configuration Professional. The minimum version required is Cisco Configuration Professional 2.8. For more information, see the Cisco Configuration Professional documentation.
Configuration
Guide for AppNav-XE for Cisco Cloud Services Router 1000V Series
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
48
Page 61
Cisco CSR 1000v Series Cloud Services Router Overview

Managing the Router Using the Cisco IOS XE REST API

Managing the Router Using the Cisco IOS XE REST API
Beginning with Cisco IOS XE Release 3.10S, and including Cisco IOS XE Denali 16.2, a REST API is available as an alternative method for managing the Cisco CSR 1000v router.
The Cisco CSR 1000v currently does not fully support IPv6 for the REST API.Note
The following requirements apply to the Cisco IOS XE REST API (formerly called the Cisco CSR 1000v REST API):
The Cisco IOS XE REST API supports only selected features and technologies compared to the Cisco
IOS XE command-line interface.
The REST API is supported over HTTPS only.
(Cisco IOS XE releases 3.13.2, 3.14.1, 3.15 and later, and Denali 16.3.1 and later) REST API (and
PNSC) support is limited to TLS.
The Cisco CSR 1000v Amazon Machine Image (AMI) does not support management of the router using
the REST API.
For more information about configuring the router to support management using the REST API, see Enabling
Management by REST API, on page 275. For more information about using the Cisco IOS XE REST API,
see the Cisco IOS XE REST API Management Reference Guide .

Managing the Router Using Cisco Prime Network Services Controller

Beginning with Cisco IOS XE Release 3.11S, you can use the Cisco Prime Network Services Controller to provision, manage, and monitor the Cisco CSR 1000v. Cisco Prime Network Services Controller can be used to streamline configuration when you are provisioning and managing many Cisco CSR 1000v VMs.
If deploying the Cisco CSR 1000v on ESXi, support for remote management using PNSC can be configured while deploying the OVA template. If deploying the Cisco CSR 1000v on other hypervisors, or if launching the Cisco CSR 1000v on an AWS instance, the PNSC configuration settings are performed using the Cisco IOS CLI.
For more information about remote management using Cisco Prime Network Services Controller, see:
Configuring the Management Interface to Support Remote Management by the Cisco Prime Network Services Controller, on page 289
Enabling Remote Management by the Cisco Prime Network Services Controller Host, on page 292
Disabling Remote Management by the Cisco Prime Network Services Controller Host, on page 295
For more information about configuring Cisco Prime Network Services Controller and using the GUI for remote management, see the following documentation:
Cisco Prime Network Services Controller Quick Start Guide
Cisco Prime Network Services Controller User Guide
The table below lists the Cisco Prime Network Services Controller versions that are compatible with the Cisco CSR 1000v.
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
49
Page 62

Cisco Unified Computing System (UCS) Products

Table 9: Cisco CSR 1000v Compatibility with Cisco Prime Network Services Controller
Cisco CSR 1000v Series Cloud Services Router Overview
Cisco IOS XE Release for Cisco CSR 1000V
Cisco IOS XE Release
3.11S
Cisco IOS XE Release
3.12S and later
Cisco Prime Network Services Controller Version
Version 3.2.1Version
3.2.2
Version 3.2.1
Version 3.2.2
Implementation
VMware ESXi
KVM
VMware ESXi
KVM
Feature SupportHypervisors Supported for
Baseline features:
Hostname, DNS,
User Credentials
Interfaces:
cloud-facing, external- facing
Interface types:
Gigabit Ethernet, loopback
NAT, NTP
ACL, Firewall
Routing: BGP,
OSPF, static routes
Syslog
Features added in this release:
Sub-interface
Cisco Unified Computing System (UCS) Products
Table 10: Cisco CSR 1000v Compatibility with Cisco UCS Servers, on page 51 lists Cisco CSR 1000v
compatibility with Cisco Unified Computing System (UCS) products.
IPSec VPN
DHCP Server/Relay
Routing: EIGRP
SNMP
NAT: Overload,
PAT
VPN Tunnel
interface
Site-to-Site VPN
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
50
Page 63
Cisco CSR 1000v Series Cloud Services Router Overview
Table 10: Cisco CSR 1000v Compatibility with Cisco UCS Servers
Cisco IOS XE Release 3.9S and later:

Finding Support Information for Platforms and Cisco Software Images

Cisco Unified Computing System (UCS) Products
The Cisco UCS server requirements are:
VMware-certified
4 or more cores configured
6 GB or more memory
VMware vCenter or standalone VMware
vSphere client installed to manage the ESXi server
See the Cisco UCS interoperability documentation to determine the UCS hardware and software that is compatible with the supported hypervisors.
Finding Support Information for Platforms and Cisco Software Images
Cisco software is packaged in feature sets consisting of software images that support specific platforms. The feature sets available for a specific platform depend on which Cisco software images are included in a release. To identify the set of software images available in a specific release or to find out if a feature is available in a given Cisco IOS XE software image, you can use Cisco Feature Navigator, the Software Advisor, or the
Cisco CSR 1000v Release Notes, Cisco IOS XE Denali 16.3 .

Using Cisco Feature Navigator

Use Cisco Feature Navigator to find information about platform support and software image support. Cisco Feature Navigator enables you to determine which Cisco IOS XE software images support a specific software release, feature set, or platform. To access Cisco Feature Navigator, go to http://www.cisco.com/go/cfn . An account on Cisco.com is not required.

Using the Software Advisor

To see if a feature is supported by a Cisco IOS XE release, to locate the software document for that feature, or to check the minimum Cisco IOS XE software requirements with your router, Cisco maintains the Software Advisor tool on Cisco.com at:
http://tools.cisco.com/Support/Fusion/FusionHome.do
You must be a registered user on Cisco.com to access this tool.
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
51
Page 64

Using the Software Release Notes

Using the Software Release Notes
Cisco IOS XE software release notes provide the following information:
Platform support
Memory recommendations
New features
Open and resolved severity 1 and 2 caveats
Release notes are intended to be release-specific for the most current release, and the information provided in these documents may not be cumulative in providing information about features that first appeared in previous releases. See Cisco Feature Navigator for cumulative feature information.
For more information, see http://www.cisco.com/c/en/us/support/routers/cloud-services-router-1000v-series/
products-release-notes-list.html.
Cisco CSR 1000v Series Cloud Services Router Overview
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
52
Page 65

Using Cisco IOS XE Software

Using Cisco IOS XE Software, page 53
Finding Command Options, page 56
NVRAM File Security, page 60

Using Cisco IOS XE Software

This chapter provides information about the Cisco IOS XE software used to configure the Cisco CSR 1000v Series Cloud Services Router. The Cisco CSR 1000v Series uses standard Cisco IOS XE CLI commands and conventions.
Commands are not case sensitive. You can abbreviate commands and parameters if the abbreviations contain enough letters to be different from any other currently available commands or parameters.
The table below lists the keyboard shortcuts for entering and editing commands.
CHAPTER 3
Table 11: Keyboard Shortcuts
Ctrl-A
PurposeKeystrokes
Move the cursor back one character.Ctrl-B or the Left Arrow key
Move the cursor forward one character.Ctrl-F orthe Right Arrow key
Move the cursor to the beginning of the command line.
Move the cursor to the end of the command line.Ctrl-E
Move the cursor back one word.Esc B
Move the cursor forward one word.Esc F
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
53
Page 66
Using Cisco IOS XE Software
The history buffer stores the last 10 commands you entered. History substitution allows you to access these commands without retyping them, by using special abbreviated commands.
Table 12: History Substitution Commands
Using Cisco IOS XE Software
PurposeCommand
Ctrl-P or the Up Arrow key
Recall commands in the history buffer, beginning with the most recent command. Repeat the key sequence to recall successively older commands.
Ctrl-N or the Down Arrow key
Return to more recent commands in the history buffer after recalling commands with Ctrl-P or the Up Arrow key.
Router# show history
While in EXEC mode, list the last several commands you have just entered.
The command modes available in the traditional Cisco IOS CLI are exactly the same as the command modes available in Cisco IOS XE.
Use the CLI to access Cisco IOS XE software. Because the CLI is divided into many different modes, the commands available to you at any given time depend on the mode that you are currently in. Entering a question mark (?) at the CLI prompt allows you to obtain a list of commands available for each command mode.
When you log in to the CLI, you are in user EXEC mode. User EXEC mode contains only a limited subset of commands. To have access to all commands, enter privileged EXEC mode, normally by using a password. From privileged EXEC mode, you can issue any EXEC commanduser or privileged modeor you can enter global configuration mode. Most EXEC commands are one-time commands. For example, show commands show important status information, and clear commands clear counters or interfaces. The EXEC commands are not saved when the software reboots.
Configuration modes allow you to make changes to the running configuration. If you later save the running configuration to the startup configuration, these changed commands are stored when the software is rebooted. To enter specific configuration modes, you must start at global configuration mode. From global configuration mode, you can enter interface configuration mode and a variety of other modes, such as protocol-specific modes.
The table below describes how to access and exit various common command modes of the Cisco IOS XE software. It also shows examples of the prompts displayed for each mode.
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
54
Page 67
Using Cisco IOS XE Software
Table 13: Accessing and Exiting Command Modes
Using Cisco IOS XE Software
Exit MethodPromptAccess MethodCommand Mode
Privileged EXEC
Global configuration
Interface configuration
Log in.User EXEC
From user EXEC mode, use the enable EXEC command.
From privileged EXEC mode, use the configure terminal privileged EXEC command.
Router>
Router#
Router(config)#
Use the logout command.
To return to user EXEC mode, use the disable command.
To return to privileged EXEC mode from global configuration mode, use the exit or end command.
From global configuration mode, specify an interface using an interface command.
Router(config-if)#
To return to global configuration mode, use the exit command.
To return to privileged EXEC mode, use the end command.
Entering a question mark (?) at the CLI prompt displays a list of commands available for each command mode. You can also get a list of keywords and arguments associated with any command by using the context-sensitive help feature.
To get help specific to a command mode, a command, a keyword, or an argument, use one of the commands listed in the table below.
Table 14: Help Commands and Purpose
help
abbreviated-command-entry?
?
command ?
PurposeCommand
Provides a brief description of the help system in any command mode.
Provides a list of commands that begin with a particular character string. (No space between command and question mark.)
Completes a partial command name.abbreviated-command-entry<Tab>
Lists all commands available for a particular command mode.
Lists the keywords or arguments that you must enter next on the command line. (Space between command and question mark.)
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
55
Page 68

Finding Command Options

Finding Command Options
This section provides an example of how to display syntax for a command. The syntax can consist of optional or required keywords and arguments. To display keywords and arguments for a command, enter a question mark (?) at the configuration prompt or after entering part of a command followed by a space. The Cisco IOS XE software displays a list and brief description of available keywords and arguments. For example, if you were in global configuration mode and wanted to see all the keywords or arguments for the arap command, you would type arap ?.
The <cr> symbol in command help output stands for carriage return.On older keyboards, the carriage return key is the Return key. On most modern keyboards, the carriage return key is the Enter key. The <cr> symbol at the end of command help output indicates that you have the option to press Enter to complete the command and that the arguments and keywords in the list preceding the <cr> symbol are optional. The <cr> symbol by itself indicates that no more arguments or keywords are available and that you must press Enter to complete the command.
The following examples show how you can use the question mark (?) to assist you in entering commands.
Table 15: Finding Command Options
Using Cisco IOS XE Software
Router> enable Password: <password> Router#
Router#
configure terminal
Enter configuration commands, one per line. End with CNTL/Z. Router(config)#
Router(config)# interface GigabitEthernet ?
<0-6> GigabitEthernet interface number
Router(config)# interface GigabitEthernet 1 Router(config-if)#
CommentCommand
Enter the enable command and password to access privileged EXEC commands. You are in privileged EXEC mode when the prompt changes to a # from the > ; for example, Router> to Router# .
Enter the configure terminal privileged EXEC command to enter global configuration mode. You are in global configuration mode when the prompt changes to Router(config)# .
Enter interface configuration mode by specifying the serial Gigabit Ethernet interface that you want to configure using the interface GigabitEthernet number global configuration command.
Enter ? to display what you must enter next on the command line.
When the <cr> symbol is displayed, you can press Enter to complete the command.
You are in interface configuration mode when the prompt changes to Router(config-if)# .
Note
The Cisco CSR 1000v supports only Gigabit Ethernet interfaces.
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
56
Page 69
Using Cisco IOS XE Software
Finding Command Options
CommentCommand
Router(config-if)# ? Interface configuration commands:
. . . ip Interface Internet Protocol
config commands
keepalive Enable keepalive lan-name LAN Name command llc2 LLC2 Interface Subcommands load-interval Specify interval for load
calculation for an
interface locaddr-priority Assign a priority group logging Configure logging for interface loopback Configure internal loopback on
an interface
mac-address Manually set interface MAC
address
mls mls router sub/interface commands
mpoa MPOA interface configuration
commands
mtu Set the interface Maximum
Transmission Unit (MTU)
netbios Use a defined NETBIOS access list
or enable
name-caching no Negate a command or set its
defaults
nrzi-encoding Enable use of NRZI encoding ntp Configure NTP . . .
Router(config-if)#
Enter ? to display a list of all the interface configuration commands available for the Gigabit Ethernet interface. This example shows only some of the available interface configuration commands.
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
57
Page 70
Finding Command Options
Using Cisco IOS XE Software
CommentCommand
Router(config-if)# ip ? Interface IP configuration subcommands:
access-group Specify access control for
packets
accounting Enable IP accounting on this
interface
address Set the IP address of an
interface
authentication authentication subcommands bandwidth-percent Set EIGRP bandwidth limit bgp BGP interface
commands..<snipped for brevity>
. . .
Router(config-if)# ip
Router(config-if)# ip address ?
A.B.C.D IP address dhcp IP Address negotiated via DHCP
pool
IP Address autoconfigured from a local DHCP pool
Router(config-if)# ip address
Router(config-if)# ip address 172.16.0.1 ?
A.B.C.D IP subnet mask
Router(config-if)# ip address 172.16.0.1
Enter the command that you want to configure for the interface. This example uses the ip command.
Enter ? to display what you must enter next on the command line. This example shows only some of the available interface IP configuration commands.
Enter the command that you want to configure for the interface. This example uses the ip address command.
Enter ? to display what you must enter next on the command line. In this example, you must enter an IP address or the negotiated keyword.
A carriage return (<cr>) is not displayed; therefore, you must enter additional keywords or arguments to complete the command.
Enter the keyword or argument that you want to use. This example uses the 172.16.0.1 IP address.
Enter ? to display what you must enter next on the command line. In this example, you must enter an IP subnet mask.
A <cr> is not displayed; therefore, you must enter additional keywords or arguments to complete the command.
Router(config-if)# ip address 172.16.0.1 255.255.255.0
?
secondary Make this IP address a secondary
address
<cr>
Router(config-if)# ip address 172.16.0.1 255.255.255.0
Router(config-if)# ip address 172.16.0.1 255.255.255.0 Router(config-if)#
Almost every configuration command has a no form. In general, use the no form to disable a function. Use the command without the no keyword to re-enable a disabled function or to enable a function that is disabled
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
58
CommentCommand
Enter the IP subnet mask. This example uses the 255.255.255.0 IP subnet mask.
Enter ? to display what you must enter next on the command line. In this example, you can enter the secondary keyword, or you can press Enter.
A <cr> is displayed; you can press Enter to complete the command, or you can enter another keyword.
In this example, Enter is pressed to complete the command.
Page 71
Using Cisco IOS XE Software
by default. For example, IP routing is enabled by default. To disable IP routing, use the no ip routing command; to re-enable IP routing, use the ip routing command. The Cisco IOS XE software command reference publications provide the complete syntax for the configuration commands and describe what the no form of a command does.
Many CLI commands also have a default form. By issuing the command default command-name , you can configure the command to its default setting. The Cisco IOS XE software command reference publications describe the function of the default form of the command when the default form performs a different function than the plain and no forms of the command. To see what default commands are available on your system, enter default ? in the appropriate command mode.
Use the copy running-config startup-config command to save your configuration changes to the startup configuration so that the changes will not be lost if the software reloads or a power outage occurs. For example:
Router# copy running-config startup-config Building configuration...
It might take a minute or two to save the configuration. After the configuration has been saved, the following output appears:
[OK] Router#
This task saves the configuration to NVRAM.
On the Cisco CSR 1000v, the startup configuration file is stored in the NVRAM partition. As a matter of routine maintenance on any Cisco router, users should backup the startup configuration file by copying the startup configuration file from NVRAM onto one of the routers other file systems and, additionally, onto a network server. Backing up the startup configuration file provides an easy method of recovering the startup configuration file in the event the startup configuration file in NVRAM becomes unusable for any reason.
The copy command can be used to backup startup configuration files. The following examples show the startup configuration file in NVRAM being backed up:
Finding Command Options
Example 1: Copying a Startup Configuration File to Bootflash
Router# dir bootflash: Directory of bootflash:/
11 drwx 16384 Jan 24 2012 04:53:55 -05:00 lost+found 12 -rw- 289243620 Jan 24 2012 04:54:55 -05:00 308257 drwx 4096 Jan 24 2012 04:57:06 -05:00 core 876097 drwx 4096 Jan 24 2012 04:57:07 -05:00 .prst_sync 63277 drwx 4096 Jan 24 2012 04:57:10 -05:00 .rollback_timer 13
-rw- 0 Jan 24 2012 04:57:19 -05:00 tracelogs.
csr1000v-adventerprisek9.2012-01-23_12.39.SSA.bin Router# copy nvram:startup-config bootflash: Destination filename [startup-config]? 3517 bytes copied in 0.647 secs (5436 bytes/sec) Directory of bootflash:/
11 drwx 16384 Jan 24 2012 04:53:55 -05:00 lost+found 12 -rw- 289243620 Jan 24 2012 04:54:55 -05:00 308257 drwx 4096 Jan 24 2012 04:57:06 -05:00 core 876097 drwx 4096 Jan 24 2012 04:57:07 -05:00 .prst_sync 632737 drwx 4096 Jan 24 2012 04:57:10 -05:00 .rollback_timer 13
-rw- 0 Jan 24 2012 04:57:19 -05:00 tracelogs.
csr1000v-adventerprisek9.2012-01-23_12.39.SSA.bin
14 -rw- 7516 Jul 2 2012 15:01:39 -07:00 startup-config
Example 2: Copying a Startup Configuration File to a TFTP Server
Router# copy bootflash:startup-config tftp: Address or name of remote host []? 172.17.16.81 Destination filename [pe24_asr-1002-confg]? /auto/tftp-users/user/startup-config
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
59
Page 72

NVRAM File Security

!! 3517 bytes copied in 0.122 secs (28828 bytes/sec)
For more detailed information on managing configuration files, see the Managing Configuration Files section in the [see "http://www.cisco.com/c/en/us/td/docs/ios-xml/ios/fundamentals/configuration/xe-3s/fundamentals-xe-3s-book.html">Configuration Fundamentals Configuration Guide, Cisco IOS XE Release 3S].
NVRAM File Security
The Cisco CSR 1000v encrypts some of the disk partitions internal to the VM to provide extra security around sensitive data that may be stored on the router. For example, information in NVRAM is encrypted so that it is not visible to administrative entities with access to the physical hard disk that the Cisco CSR 1000v is stored on.
You can search and filter the output of show and more commands. This functionality is useful if you need to sort through large amounts of output or if you want to exclude output that you need not see.
To use this functionality, enter a show or more command followed by the pipecharacter ( | ); one of the keywords begin, include, or exclude; and a regular expression on which you want to search or filter (the expression is case sensitive):
Using Cisco IOS XE Software
showcommand{append|| begin | | exclude | | exclude | | include | | redirect | | section | | tee}regular-expression
show command | {append | begin | exclude | include | redirect | section | tee} regular-expression
The output matches certain lines of information in the configuration file.
To power off the Cisco CSR 1000v, you must power off the VM the router is installed on. For information about powering off the VM, see your VM vendor documentation.
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
60
Page 73

Installation Overview

Introduction

Cisco hardware routers are normally shipped with the Cisco IOS XE software pre-installed. Because the Cisco CSR 1000v Series Cloud Services Router is not hardware-based, you must download the Cisco IOS XE software from Cisco.com and install it directly onto the virtual machine. However, as part of the initial installation process, you must first provision the attributes of the VM so that the Cisco CSR 1000v software can install and boot.
Introduction, page 61
Obtaining the Cisco CSR 1000v VM Image, page 63
Cisco CSR 1000v Installation Files, page 63
Cisco CSR 1000v Installation Options, page 64
Guidelines and Limitations, page 66
ROMMON and the Cisco CSR 1000v, page 66
Where to Go Next, page 66
CHAPTER 4
Note
Note
For information about deploying the Cisco CSR 1000v in an Amazon Web Services environment, seehttp:/
/www.cisco.com/c/en/us/td/docs/routers/csr1000/software/aws/csraws.html.
For information about deploying the Cisco CSR 1000v in a Microsoft Azure environment, see http://
www.cisco.com/c/en/us/td/docs/routers/csr1000/software/azu/csrazure.html.
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
61
Page 74
Introduction
Installation Overview
The figure below ("Cisco CSR 1000v Installation Task Workflow") shows the high-level tasks required to install the Cisco CSR 1000v on the VM. The different installation options are dependent on the hypervisor being used. See the following sections for more information.
Figure 2: Cisco CSR 1000v Installation Task Workflow
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
62
Page 75
Installation Overview

Obtaining the Cisco CSR 1000v VM Image

SUMMARY STEPS
Open Cisco CSR 1000v Cloud Services Router product page:
1.
Click the Download Software for this Product link to open the Download Software page.
2.
On the Download Software page, select the router model (Cloud Services Router 1000v).
3.
Click IOS XE Software. The recommended Cisco IOS XE release is selected by default.
4.
In the list of available images, click Download Now or Add to Cart. Follow the instructions for downloading
5.
the software.
DETAILED STEPS
Obtaining the Cisco CSR 1000v VM Image
Step 1
Step 2 Step 3 Step 4 Step 5
Open Cisco CSR 1000v Cloud Services Router product page: [add xref to http://www.cisco.com/c/en/us/products/routers/cloud-services-router-1000v-series/index.html]
Click the Download Software for this Product link to open the Download Software page.
On the Download Software page, select the router model (Cloud Services Router 1000v).
Click IOS XE Software. The recommended Cisco IOS XE release is selected by default.
In the list of available images, click Download Now or Add to Cart. Follow the instructions for downloading the software.

Cisco CSR 1000v Installation Files

The following software images are available for installing the Cisco CSR 1000v on the supported hypervisors.
.ova
Used for deploying the OVA template on the VM (in TAR format)
.iso
Used for installing the software image on the VM (requires manually creating the VM)
.qcow2
Used for installing the software image in KVM OpenStack environments.
.run
(Cisco IOS XE 3.16 and later, and Cisco IOS XE Denali 16.3.1 and later) Self-installing image used for installation in a KVM environment.
.bin
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
63
Page 76

Cisco CSR 1000v Installation Options

These images are used for upgrading and downgrading the software only. For more information, see
Prerequisites for the Software Upgrade Process, on page 199 and subsequent sections.
Installation Overview
Note
Note
(Cisco IOS XE Everest 16.5 and later) On AWS, you can use the Cisco CSR 1000v .bin file to upgrade the version of Cisco CSR 1000v, without having to recreate AWS EC2 instance from a new AMI. This inline upgrade process is not yet available on Microsoft Azure.
(Cisco IOS XE Everest 16.4 and earlier) You cannot use the Cisco CSR 1000v .bin file to upgrade AMIs obtained from Amazon Web Services. You must create a new AMI instance and migrate your configuration and licenses.
Cisco CSR 1000v Installation Options
The Cisco CSR 1000v supports the following installation options:
Deploy the OVA template on the VM.
Uses the .ova file. This template creates a VM using recommended preset values. See Deploying the
Cisco CSR 1000v OVA to the VM using vSphere, on page 76 and Deploying the Cisco CSR 1000v OVA to the VM using COT, on page 84.
The .ova file can be used only for first-time installation. It cannot be used for upgrading the Cisco IOS XE software version.
Deploy the .ova file on the VM using the Common OVF Tool (COT).
The COT application is included in the file package. However, to ensure that you are using the latest version of COT, download COT directly from the GitHub site:
Note
https://github.com/glennmatthews/cot/blob/master/README.md
Using the COT application, you can customize the VM values and easily deploy the custom VM as part of the Cisco CSR 1000v installation process. See Editing the Basic Properties of Cisco CSR 1000v using
vSphere, on page 81.
The COT application is recommended in place of the BDEO tool, which is used in early releases of Cisco IOS XE.
Manually configure the VM using the .iso file.
Uses the .iso file. You can install the .iso file on your host and manually create the VM using your hypervisor software. For example, if you are installing the Cisco CSR 1000v on VMware, you would install the .iso file on the VMware ESXi host, and manually create the VM using the vSphere GUI. See the following sections:
Manually Creating the Cisco CSR 1000v VM Using the .iso File (VMware ESXi), on page 92
Manually Creating the Cisco CSR 1000v VM Using the .iso File (Citrix XenServer), on page 107
Creating the Cisco CSR 1000v VM Using virt-install—Using ISO Image, on page 120
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
64
Page 77
Installation Overview
Cisco CSR 1000v Installation Options
Prerequisites for Manually Creating the CSR 1000v VM using the .iso File, on page 137
Create the Cisco CSR 1000v instance in KVM using OpenStack
Uses the .qcow2 file. The qcow2 (QEMU Copy on Write) image format is used to create the Cisco CSR 1000v tenant in the KVM OpenStack cloud environment. See Selecting a Cisco CSR 1000v Installation Image, on
page 122 onwards.
BDEO Tool
The Cisco Build, Deploy, Execute OVF (BDEO) tool is included in the OVA package. In past releases, this tool was recommended for Cisco CSR 1000v installation. The tool is no longer recommended, but is included in the package for unusual installation circumstances. You should use the COT application instead of the BDEO tool.
Upgrading Cisco IOS XE Software
For information about upgrading the Cisco IOS XE software, see Prerequisites for the Software Upgrade
Process, on page 199and subsequent sections.
Installation Options and Requirements
The following table lists the installation options for the supported hypervisors and the minimum Cisco IOS XE software release required.
Table 16: Cisco CSR 1000v Supported Installation Options
Deploy OVA Template Using OVA Wizard
later
Deploy OVA Using COT
later
Manually Configure VM Using .iso File
Cisco IOS XE 3.9S and later. (Cisco IOS XE Denali 16.2 is not supported by CSR 1000v.)
on OpenStack Using .qcow2 File
Cisco IOS XE 3.10S and later. (Cisco IOS XE Denali 16.2 is not supported by CSR 1000v.)
NANACreate the KVM instance
Cisco IOS XE 3.10S and later. (Cisco IOS XE Denali 16.2 is not supported by CSR 1000v.)
later. (Cisco IOS XE Denali 16.2 is not supported by CSR 1000v.)
Microsoft Hyper-VKVMCitrix XenServerVMware ESXiInstallation Option
Not supportedNot supportedNot supportedCisco IOS XE 3.9S and
Not supportedNot supportedNot supportedCisco IOS XE 3.9S and
Cisco IOS XE 3.12S and later. (Cisco IOS XE Denali 16.2 is not supported by CSR 1000v.)
NACisco IOS XE 3.12S and
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
65
Page 78

Guidelines and Limitations

Guidelines and Limitations
Be aware of the following general guidelines and restrictions before installing the Cisco CSR 1000v in your network:
If the hypervisor does not support vNIC Hot Add/Remove, do not make any changes to the VM hardware
(memory, CPUs, hard drive size, and so on) while the VM is powered on.
(Cisco IOS XE Release 3.11S and later) The GigabitEthernet0 interface is no longer available. You can
designate any interface as the management interface.
(Cisco IOS XE Release 3.10S and earlier) The GigabitEthernet0 interface is the default management
port and cannot be changed.
The Cisco IOS XE CLI can be accessed either through the virtual VGA console or the console on the
virtual serial port. The console can be selected from GRUB mode during the first-time installation, or it can be changed using the Cisco IOS XE platform console command after the router boots. For more information, see Booting the Cisco CSR 1000v as the VM, on page 145.
Installation Overview
Note
Some hypervisors may not support serial console access. Verify support using your hypervisor documentation.

ROMMON and the Cisco CSR 1000v

The Cisco CSR 1000v, which is software-based, does not include a ROMMON image. This differs from many Cisco hardware-based routers. During the initial bootloader process, the installation script creates a clean version of the Cisco CSR 1000v software image known as the Golden Image and places it in a non-accessible partition. This clean version can be used if the software image is not working properly or is not bootable.
Note that although the Cisco CSR 1000v does not include ROMMON, the platform does include a GNU GRand Unified Bootloader (GRUB)-based bootloader. The GRUB function on the Cisco CSR 1000v provides more limited functionality compared to the ROMMON available on other Cisco platforms.
Note that although ROMMON is not present on the Cisco CSR 1000v, some Cisco IOS XE commands such as show version may show references to ROMMON in the command output.
Note
After the Cisco CSR 1000v completes the first-time installation, you can configure the router to automatically enter GRUB mode when the router is booted. For more information, see Activating Cisco
CSR 1000v Licenses, on page 156 and subsequent licensing sections.

Where to Go Next

See the information in the sections below, about installing the Cisco CSR 1000v in different hypervisor environments:
VMware ESXi Support Information, on page 69
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
66
Page 79
Installation Overview
Microsoft Hyper-V Support Information, on page 135
Citrix XenServer Support Information, on page 105
Kernel Virtual Machine Support Information, on page 113
Where to Go Next
Note
Note
For information about deploying the Cisco CSR 1000v in an Amazon Web Services environment, see the
Cisco CSR 1000V Series Cloud Services Router Deployment Guide for Amazon Web Services.
For information about deploying the Cisco CSR 1000v in a Microsoft Azure environment, see the Cisco
CSR 1000v Deployment Guide for Microsoft Azure.
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
67
Page 80
Where to Go Next
Installation Overview
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
68
Page 81
CHAPTER 5

Installing the Cisco CSR 1000v in VMware ESXi Environments

VMware ESXi Support Information, page 69
VMware Requirements—Cisco IOS XE Everest 16.6, page 70
Supported VMware Features and Operations, page 71
Deploying the Cisco CSR 1000v OVA to the VM, page 76
Manually Creating the VM and Installing the Cisco CSR 1000v Software Using the .iso File (VMware
ESXi), page 90
Increasing Performance on VMware ESXi Configurations, page 94
VMware Requirements—Cisco IOS XE Everest 16.5, page 94
VMware Requirements—Cisco IOS XE Everest 16.4, page 95
VMware Requirements—Cisco IOS XE Denali 16.3, page 96
VMware Requirements—Cisco IOS XE 3.x, page 97
VMware VM Requirements—Cisco IOS XE 3.x, page 99
Installation Requirements—Cisco IOS XE 3.x, page 101

VMware ESXi Support Information

This section includes information about VMware tools/software,and VM requirements required by the Cisco CSR 1000v running the latest Cisco IOS XE Denali 16.3.1 software, as well as a list of the supported VM features.
The Cisco CSR 1000v can run on the VMware ESXi hypervisor. VMware ESXi runs on PCs with x86-based CPUs. You can use the same hypervisor to run several VMs.
VMware vSphere Web Client is a web application that runs on the PC and accesses vCenter Server. You can use VMware vSphere Web Client software to create, configure, and manage VMs on the VMware vCenter Server and to start/stop the Cisco CSR 1000v. The Cisco CSR 1000v can boot from a virtual disk located on the data store.
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
69
Page 82
Installing the Cisco CSR 1000v in VMware ESXi Environments

VMware RequirementsCisco IOS XE Everest 16.6

To find out more about installing vSphere products, see VMware product documentation .
VMware RequirementsCisco IOS XE Everest 16.6
The VMware tools supported by Cisco CSR 1000v using Cisco IOS XE Everest 16.6 are as follows:
Note
Note
For VMware requirementsCisco IOS XE 3.x, see VMware RequirementsCisco IOS XE 3.x, on page
97 and VMware VM RequirementsCisco IOS XE 3.x, on page 99.
VMware vSphere Web Client. The following versions of VMware vSphere Web Client are supported:
VMware vSphere Web Client 6.0
VMware vSphere Web Client 5.5
VMware vCenter Server. The following versions of VMware vCenter Server are supported:
VMware ESXi 6.0 update 2 (instance running vm11). This version is recommended. This version has
been fully tested and meets performance benchmarks.
VMware ESXi 5.5 update 3 (instance running vm10). This version is supported. However, note that
version 6.0 update 2 is recommended
VMware vCenterinstallation tool.
VMware vSwitchstandard or distributed vSwitches are supported.
Hard Driveonly a single hard disk drive is supported. Multiple hard disk drives on a VM are not supported.
Virtual Diska 8 GB virtual disk is supported.
vCPUsthe following vCPU configurations are supported:
The required vCPU configuration depends on the throughput license and technology package installed. For more information, see the data sheet for your release.
1 vCPU: requires minimum 4 GB RAM allocation
2 vCPUs: requires minimum 4 GB RAM allocation
4 vCPUs: requires minimum 4 GB RAM allocation
8 vCPUs: requires minimum 4 GB RAM allocation
Virtual CPU coreone virtual CPU core is required. This needs a 64-bit processor with Virtualization Technology (VT) enabled in the BIOS setup of the host machine.
Virtual hard disk spaceminimum 8 GB size is required.
Virtual Network Interface Cards (vNICs)Three or more vNICs (max. 10)VMXNET3are supported.
A default video, SCSI controller set is required, and an installed virtual CD/DVD drive.
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
70
Page 83
Installing the Cisco CSR 1000v in VMware ESXi Environments

Supported VMware Features and Operations

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.
The table "Supported VMware Features and Operations: Storage Options (for Both vCenter Server and vSphere Client)" 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 VMware 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 sections for more information.
General Features (vCenter Server), on page 71
Operations (for vCenter Server and vSphere Web Client), on page 72
High Availability, on page 74
Storage Options (for vCenter Server and vSphere Web Client), on page 75

General Features (vCenter Server)

Table 17: Supported VMware Features and Operations: General Features (for vCenter Server Only)
Cisco IOS XE Release 3.9SCloning
DescriptionFirst Supported Cisco CSR 1000v ReleaseSupported Entities
Enables cloning a virtual machine or template, or cloning a virtual machine to a template.
Cisco IOS XE Release 3.9SMigrating
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
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.
71
Page 84

Operations (for vCenter Server and vSphere Web Client)

Installing the Cisco CSR 1000v in VMware ESXi Environments
DescriptionFirst Supported Cisco CSR 1000v ReleaseSupported Entities
Cisco IOS XE Release 3.9SvMotion
Enables moving the VM from one physical server to another while the VM remains active.
Cisco IOS XE Release 3.9STemplate
Uses templates to create new virtual machines by cloning the template as a virtual machine.
Operations (for vCenter Server and vSphere Web Client)
Table 18: Supported VMware Features and Operations: Operations (for vCenter Server and vSphere Client)
DescriptionFirst Supported Cisco CSR 1000v ReleaseSupported Entities
Cisco IOS XE Release 3.9SPower On
Cisco IOS XE Release 3.9SPower Off
Powers on the virtual machine and boots the guest operating system if the guest operating system is installed.
Stops the virtual machine until it is powered back. The power off option performs a hardpower off, which is analogous to pulling the power cable on a physical machine and always works.
Not supported.Shut Down
Shut Down, or softpower 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.
Suspends the virtual machine.Not supportedSuspend
Cisco IOS XE Release 3.9SReset/Restart
Stops the virtual machine and restarts (reboots) it.
Cisco IOS XE Release 3.9SOVF Creation
An OVF package consisting of several files in a directory captures the state of a virtual machine including disk files that are stored in a compressed format. You can export an OVF package to your local computer.
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
72
Page 85
Installing the Cisco CSR 1000v in VMware ESXi Environments
Operations (for vCenter Server and vSphere Web Client)
DescriptionFirst Supported Cisco CSR 1000v ReleaseSupported Entities
Cisco IOS XE Release 3.9SOVA Creation
Table 19: Supported VMware Features and Operations: Networking Features
Cisco IOS XE Release 3.9SCustom MAC address
Cisco IOS XE Release 3.9SDistributed VSwitch
Cisco IOS XE Release 3.10SDistributed Resources Scheduler
You can create a single OVA package file from the OVF package/template. The OVA can then be distributed more easily; for example, it may be downloaded from a website or moved via a USB key.
DescriptionFirst Supported Cisco CSR 1000v ReleaseSupported Entities
From both vCenter Server and vSphere Client. Allows you to set up the MAC address manually for a virtual network adapter.
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.
Provides automatic load balancing across hosts.
Cisco IOS XE Release 3.9SNIC Load Balancing
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.
Cisco IOS XE Release 3.9SNIC Teaming
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.
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
73
Page 86

High Availability

Installing the Cisco CSR 1000v in VMware ESXi Environments
DescriptionFirst Supported Cisco CSR 1000v ReleaseSupported Entities
Cisco IOS XE Release 3.9SvSwitch
High Availability
Note
Table 20: Supported VMware Features and Operations: High Availability
Cisco IOS-based High Availability is not supported by the Cisco CSR 1000v. High Availability is supported on the VM host only.
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.
DescriptionFirst Supported Cisco CSR 1000v ReleaseSupported Entities
Cisco IOS XE Release 3.9SVM-Level High Availability
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.
Cisco IOS XE Release 3.9SHost-Level High Availability
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.
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
74
Page 87
Installing the Cisco CSR 1000v in VMware ESXi Environments

Storage Options (for vCenter Server and vSphere Web Client)

DescriptionFirst Supported Cisco CSR 1000v ReleaseSupported Entities
Cisco IOS XE Release 3.10SFault Tolerance
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.
Storage Options (for vCenter Server and vSphere Web Client)
Table 21: Supported VMware Features and Operations: Storage Options (for Both vCenter Server and vSphere Client)
DescriptionFirst Supported Cisco CSR 1000v ReleaseSupported Entities
Storage Options (for both vCenter Server and vSphere Client)
Cisco IOS XE Release 3.9SLocal Storage
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.
Cisco IOS XE Release 3.9SExternal Storage Target
You can deploy the Cisco CSR 1000v on external storage, that is, a Storage Area Network (SAN).
Cisco IOS XE Release 3.9SMount or Pass Through of USB Storage
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.
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
75
Page 88
Installing the Cisco CSR 1000v in VMware ESXi Environments

Deploying the Cisco CSR 1000v OVA to the VM

Deploying the Cisco CSR 1000v OVA to the VM

Deploying the Cisco CSR 1000v OVA to the VM
You can use the provided CSR 1000v OVA file package to deploy the Cisco CSR 1000v to the VM. The OVA package includes an OVF file that contains a default VM configuration based on a Cisco IOS XE release and the supported hypervisor. (See the Guidelines and Limitationssection of the installation configuration that is included in the OVA file.)
The OVA can be deployed using VMware vSphere or COT (Common OVF Tool).
Deploying the Cisco CSR 1000v OVA to the VM using vSphere, on page 76
Deploying the Cisco CSR 1000v OVA to the VM using COT, on page 84
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 Cisco CSR 1000v OVA to the VM using vSphere

Deploying the Cisco CSR 1000v OVA to the VM using vSphere
You can use the provided CSR 1000v OVA file package to deploy the Cisco CSR 1000v to the VM. The OVA package includes an OVF file that contains a default VM configuration based on a Cisco IOS XE release and the supported hypervisor. (See the Guidelines and Limitationssection 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.
Restrictions and Requirements, on page 76
Deploying the Cisco CSR 1000v OVA to the VM, on page 76
Editing the Basic Properties of Cisco CSR 1000v using vSphere, on page 81
Editing the Custom Properties of Cisco CSR 1000v using vSphere, on page 83
Restrictions and Requirements
The following restrictions apply when deploying the OVA package 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, first deploy the OVA template, and then use vSphere to change the virtual CPU configuration and the required RAM allocation.
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
76
Page 89
Installing the Cisco CSR 1000v in VMware ESXi Environments
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.
When deploying the OVA, the VM requires two virtual CD/DVD drives, one for the OVF environment
file and one for the .iso file.
Deploying the OVA to the VM
Perform the following steps in VMware vSphere Client:
SUMMARY STEPS
Log in to the VMware vSphere Client.
1.
From the vSphere Client Menu Bar, choose File > Deploy OVF Template.
2.
In the OVA Wizard, point the source to the Cisco CSR 1000v OVA to be deployed. Click Next.
3.
Under Name and Inventory Location, specify the name for the VM and click Next.
4.
(Cisco IOS XE Release 3.12S and later): Under Deployment Configuration, select the desired hardware
5.
configuration profile from the drop-down menu and click Next.
Under Storage, select the Datastore to use for the VM. Click Next.
6.
Under Disk Format, select the disk format option:
7.
Under Network Mapping, allocate one or more virtual network interface card (vNIC) on the destination
8.
network using the drop-down list. The options for mapping the vNICs differ depending on the release version:
Configure the properties for the VM.
9.
Select Power on after deployment to automatically power on the VM.
10.
Click Finish to deploy the OVA.
11.
Deploying the Cisco CSR 1000v OVA to the VM using vSphere
DETAILED STEPS
Step 1 Step 2 Step 3
Log in to the VMware vSphere Client.
From the vSphere Client Menu Bar, choose File > Deploy OVF Template.
In the OVA Wizard, point the source to the Cisco CSR 1000v OVA to be deployed. Click Next. OVF Template Details appears, showing information about the OVA. Click Next.
Step 4 Step 5
Under Name and Inventory Location, specify the name for the VM and click Next.
(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 Step 7
Under Storage, select the Datastore to use for the VM. Click Next.
Under Disk Format, select the disk format option:
Note
Thick Provision Lazy Zeroed
Thick Provision Eager Zeroed
The Thin Provision option is not supported. The Thick Provision Eager Zeroed option takes longer to install but provides better performance.
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
77
Page 90
Deploying the Cisco CSR 1000v OVA to the VM using vSphere
Click Next.
Installing the Cisco CSR 1000v in VMware ESXi Environments
Step 8
Step 9
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, and IOS XE Denali 16.2 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 routers management interface when setting the bootstrap properties (see table "Bootstrap Properties for Cisco IOS XE Release 3.11S and Later" below).
(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 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.
Configure the properties for the VM. The available properties differ depending on the Cisco IOS XE release that you are using. See the tables below for the OVA bootstrap properties for the relevant release of Cisco IOS XE.
Note
The bootstrap properties are optional when creating the VM. You can set these properties to easily provision the VM before starting it up.
DescriptionProperty
(Cisco IOS XE 3.17S and later, and Denali 16.2 and later)
Configures the console mode.
Possible values: auto, virtual, serial
Sets the login username for the router.Login Username
Sets the login password for the router.Login Password
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.
Configures the dot1Q VLAN interface. Requires the management interface to be configured using the GigabitEthernetx.xxx format.
Configures the IPv4 address and subnet mask for the management interface.
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
78
Page 91
Installing the Cisco CSR 1000v in VMware ESXi Environments
Deploying the Cisco CSR 1000v OVA to the VM using vSphere
DescriptionProperty
Management IPv4 Default Gateway
Management IPv4 Gateway
Management IPv4 Network
Remote Management IPv4 Address
PNSC IPv4 Address
(Cisco IOS XE Release 3.11S through 3.17S, and Denali 16.2 and later)
Configures the IPv4 management default gateway address. If using DHCP, enter dhcpin the field.
(Cisco IOS XE Release 3.12S through 3.17S, and Denali 16.2 and later)
Configures the IPv4 management default gateway address. If using DHCP, enter dhcpin the field.
(Cisco IOS XE Release 3.12S through 3.17S, and Denali 16.2 and later)
Configures the IPv4 Network (such as 192.168.2.0/24or 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.
(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. See Introduction to REST API Configuration
Options, on page 277.
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
PNSC Shared Secret Key
(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.
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.
Configures the hostname of the router.Router name
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
79
Page 92
Deploying the Cisco CSR 1000v OVA to the VM using vSphere
Installing the Cisco CSR 1000v in VMware ESXi Environments
DescriptionProperty
(Cisco IOS XE 3.16S2 and later, and Denali 16.2 and later)
Configures the Resource Template.
Possible values: default, service_plane_medium, service_plane_heavy
Enables the IOS SCP feature.Enable SCP Server
(Enable SSH Login, Cisco IOS XE Release 3.11S)
(Enable SSH Login and Disable Telnet Login, Cisco IOS XE Release
3.12S and later, and Denali 16.2 and later)
Enables remote login using SSH and disables remote login via Telnet. Requires that the login username and password are set.
Configures the password for privileged (enable) access.Enable Password
Configures the network domain name.Domain Name
(Cisco IOS XE 3.13S and later, and Denali 16.2 and later)
Configures the license technology level that is available when the Cisco CSR 1000v boots.
DescriptionProperty
Sets the login username for the router.Login Username
Sets the login password for the router.Login Password
Sets the management gateway address/mask in IPv4 format for the GigabitEthernet0 management interface.
Sets the default management gateway IP address in IPv4 format for the GigabitEthernet0 management interface.
Configures the hostname of the router.Router name
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
80
Page 93
Installing the Cisco CSR 1000v in VMware ESXi Environments
Deploying the Cisco CSR 1000v OVA to the VM using vSphere
DescriptionProperty
Enable HTTP Server
Enable HTTPS Server
Enable SSH Login
Additional Configuration Properties
When finished configuring the router properties, click Next. The Ready to Complete screen displays, showing the settings to be used when the OVA is deployed.
You can also configure advanced properties after the router boots.
(Cisco IOS XE Release 3.9S only)
Enables an HTTP server for system configuration and administration via a web browser.
(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.
Enables remote login using SSH and disables remote login via Telnet. Requires that the login username and password are set.
Configures the password for privileged (enable) access.Enable Password
Configures the network domain name.Domain Name
Step 10 Step 11
Select Power on after deployment to automatically power on the VM.
Click Finish to deploy the OVA. The OVA deploys the .iso file and, if the Power on after deploymentsetting 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 Booting the Cisco CSR 1000v and Accessing the Console, on page 145.
Editing the Basic Properties of Cisco CSR 1000v using vSphere
When deploying the OVA template, you have the option to set basic router properties using the vSphere GUI prior to booting, as described in Deploying the Cisco CSR 1000v OVA to the VM using vSphere, on page
76. You can also set custom properties matched to Cisco IOS XE CLI commands. See Editing the Custom Properties of Cisco CSR 1000v using vSphere, on page 83.
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 Editing the Custom Properties
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
81
Page 94
Deploying the Cisco CSR 1000v OVA to the VM using vSphere
of Cisco CSR 1000v using vSphere, on page 83 . 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:
SUMMARY STEPS
In the vSphere GUI, select the Options tab.
1.
Choose vApp Options > Properties.
2.
Click on the Properties button.
3.
Select the property to be edited and click Edit.
4.
Once you have edited the property, click OK to close.
5.
DETAILED STEPS
Installing the Cisco CSR 1000v in VMware ESXi Environments
Step 1 Step 2
In the vSphere GUI, select the Options tab.
Choose vApp Options > Properties.
Figure 3: vApp Advanced Options for Cisco CSR 1000v
Step 3
82
Click on the Properties button. A new window opens that provides access to the properties that can be edited. See the example Advanced Property Configuration Screen below.
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
Page 95
Installing the Cisco CSR 1000v in VMware ESXi Environments
Deploying the Cisco CSR 1000v OVA to the VM using vSphere
Note
These properties can also be set using selected steps of the procedure described in Deploying the Cisco CSR
1000v OVA to the VM using vSphere, on page 76.
Figure 4: Cisco CSR 1000v Advanced Property Configuration Screen
See the tables in Deploying the Cisco CSR 1000v OVA to the VM using vSphere, on page 76 for the basic Cisco CSR 1000v properties that can be edited in the vSphere vApps GUI.
Step 4 Step 5
Select the property to be edited and click Edit.
Once you have edited the property, click OK to close.
Editing the Custom Properties of Cisco CSR 1000v using vSphere
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 you 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:
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
83
Page 96

Deploying the Cisco CSR 1000v to the VM using COT

SUMMARY STEPS
In the vSphere GUI, select the Options tab.
1.
Choose vApp Options > Advanced.
2.
Click on the Properties button.
3.
Click New to add a property.
4.
Enter the information to create the new custom property based on a Cisco IOS XE CLI command:
5.
When finished, click OK.
6.
In the Advanced Property Configuration window, click OK.
7.
Reboot the Cisco CSR 1000v.
8.
DETAILED STEPS
Installing the Cisco CSR 1000v in VMware ESXi Environments
Step 1 Step 2
Step 3 Step 4
Step 5
Step 6 Step 7 Step 8
In the vSphere GUI, select the Options tab.
Choose vApp Options > Advanced. The Advanced Property Configuration window appears.
Click on the Properties button.
Click New to add a property. The Edit Property Settings window appears.
Enter the information to create the new custom property based on a Cisco IOS XE CLI command:
Note
a) (Optional) Enter the label. This is a descriptive string for the property. b) c)
d) (Optional) Enter a description for the property. e) f) Enter the default value as the Cisco IOS XE CLI command the custom property is based on.
When finished, click OK.
In the Advanced Property Configuration window, click OK.
Reboot the Cisco CSR 1000v. The router must reboot in order for the new or edited properties to take effect.
Before adding a custom property, make sure that the Cisco IOS XE command upon which it is based is supported on the Cisco CSR 1000v in your release.
Enter the class ID as com.cisco.csr1000v. Assign the property an ID of ios-config-xxxxwhere xxxx is a sequence number from 0001 to 9999 that determines
the order in which the custom properties are applied.
Enter the property type as string. This is the only type supported.
Deploying the Cisco CSR 1000v to the VM using COT
Deploying the Cisco CSR 1000v OVA to the VM using COT
You can use the provided CSR 1000v OVA file package to deploy the Cisco CSR 1000v to the VM. The OVA package includes an OVF file that contains a default VM configuration based on a Cisco IOS XE release
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
84
Page 97
Installing the Cisco CSR 1000v in VMware ESXi Environments
and the supported hypervisor. (See the Guidelines and Limitationssection of the installation configuration that is included in the OVA file.) The OVA can be deployed using VMware vSphere or COT (Common OVF Tool). This section describes how to deploy using the COT (Common OVF Tool).
The Common OVF Tool (COT) 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 VMs with the CSR 1000v software pre-installed. This tool can speed the process of deploying Cisco CSR 1000v on multiple VMs.
COT provides a simple command-line interface to enter the VM attributes into the .ova file. COT can be run either in a LINUX shell or on Mac OS X. VMware ovftools must be installed.
The Common OVF Tool (COT) is provided without official Cisco support. Use it at your own risk.Danger
Downloading COT, on page 85
Editing the Basic Properties of Cisco CSR 1000v using COT, on page 85
Editing the Custom Properties of Cisco CSR 1000v using COT, on page 86
Deploying the Cisco CSR 1000v VM using COT, on page 89
Deploying the Cisco CSR 1000v to the VM using COT
COT Restrictions
COT supports deployment of the OVA package directly onto an ESXi host. The tool does not support
Citrix XenServer, KVM or Microsoft Hyper-V environments.
Downloading COT
Download and install the COT libraries and script according to the instructions on the GitHub site:
http://cot.readthedocs.io/en/latest/installation.html
Editing the Basic Properties of Cisco CSR 1000v using COT
Before deploying Cisco CSR 1000v using COT, you can edit the basic or custom properties of the Cisco CSR 1000v VM in the OVA package using COT.
To edit the basic properties of the OVA, use the cot edit-properties command.
cot edit-properties
-p key1=value1, --properties key1=value1
Sets properties using key value pairs. Example: -p "login-username=cisco" sets the login username using a key value pair.
-o output
Specifies the name or path to a new OVA package, if you are creating a new OVA instead of updating the existing OVA.
For more information on COT command cot edit-properties, see: http://cot.readthedocs.io/en/latest/usage_
edit_properties.html
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
85
Page 98
Deploying the Cisco CSR 1000v to the VM using COT
Editing the Basic Properties of Cisco CSR 1000v using COT: Example
cot edit-properties csr1000v-universalk9.ova
-p "login-username=cisco"
-p "login-password=cisco"
-o csr1000v-universalk9-customized.ova
\# save modifications to a new OVA
cot info csr1000v-universalk9-customized.ova
# verify the new values of properties in the OVA (...) Properties:
<config-version> "1.0"
Router Name ""
Login Username "cisco"
Login Password "cisco"
Management Interface "GigabitEthernet1"
Management VLAN ""
Management Interface IPv4 Address/Mask ""
The table below shows the cot edit-properties command and arguments used in the above example.
Installing the Cisco CSR 1000v in VMware ESXi Environments
DescriptionScript Step
cot edit propertie s csr1000v-universalk9.ova
-p "login-username=cisco"
-p "login-password=cisco"
-o "csr1000v-universalk9-customized.ova"
Edits the basic environment properties of this OVA (csr1000v-universalk9.ova).
Sets the bootstrap login username.
Sets the bootstrap login password.
Saves a modified OVA, which contains config commands from the text file.
Editing the Custom Properties of Cisco CSR 1000v using COT
Before doing the procedures shown in section Deploying the Cisco CSR 1000v VM using COT, on page 89, you can edit custom properties, for example to include Cisco IOS XE CLI commands.
To edit the custom properties of the OVA, use one of the following two commands:
cot edit-properties; see cot edit-properties, on page 86.
cot inject-config; see cot inject-config, on page 88.
cot edit-properties
Use the cot edit-properties command to pre-apply a small number of configuration commands to the OVA. (Otherwise, for a larger number of commands, consider using the cot inject-config command; see cot
inject-config, on page 88.)
For further details about the cot edit-properties command, see http://cot.readthedocs.io/en/latest/usage_edit_
properties.html .
Synopsis and Description
cot edit-properties ova-filename
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
86
Page 99
Installing the Cisco CSR 1000v in VMware ESXi Environments
-o output
Specifies the name or path to a new OVA package, if you are creating a new OVA instead of updating the existing OVA.
-c config-file
Specifies the name of a text file containing IOS XE commands to be added to the OVA.
Example
In this example, a previously created text file, iosxe_config.txt, containing IOS XE config commands is added to the OVA using the cot edit-properties command. Finally the cot info command is used to show the modified OVA.
$ cat iosxe_config.txt
interface GigabitEthernet1 no shutdown ip address 192.168.100.10 255.255.255.0 ! ip route 0.0.0.0 0.0.0.0 GigabitEthernet1 192.168.100.1 $ cot edit-properties csr1000v-universalk9.ova \
-o csr1000v-universalk9-customized.ova \
-c iosxe_config.txt
$ cot info csr1000v-universalk9-customized.ova
...
Deploying the Cisco CSR 1000v to the VM using COT
Properties:
<config-version> "1.0" Router Name ""
...
Intercloud Tunnel Interface Gateway IPv4 Address "" <ios-config-0001> "interface GigabitEthernet1" <ios-config-0002> "no shutdown" <ios-config-0003> "ip address 192.168.100.10 255.255.255.0" <ios-config-0004> "ip route 0.0.0.0 0.0.0.0 GigabitEthernet1 192.168.100.1"
The table below shows the cot edit properties command and arguments used in the example.
DescriptionScript Step
cot edit properties csr1000v-universalk9.ova
-o "csr1000v-universalk9-customized.ova"
-c iosxe_config.txt
Edits the custom environment properties of this OVA (csr1000v-universalk9.ova).
New OVA, containing configuration commands from the text file.
Text file that contains IOS XE configuration commands. Each line of configuration in this file results in a entry such as com.cisco.csr1000v.ios-config-xxxx in the XML of the OVF.
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
87
Page 100
Deploying the Cisco CSR 1000v to the VM using COT
cot inject-config
Use the cot inject-config command if you have a large set of configuration commands to pre-apply to the OVA; for example, if you want to add a complete running configuration. This is efficient in terms of file size and loading time as it uses plain text for the configuration commands (instead of XML). For further details about the cot inject-config command, see
http://cot.readthedocs.io/en/latest/usage_inject_config.html
Synopsis and Description
cot inject-config ova-filename
-o output
Specifies the name or path to a new OVA package, if you are creating a new OVA instead of updating the existing OVA.
-c config-file
Specifies the name of a text file, such as iosxe_config.txt , to be embedded in the OVA.
Installing the Cisco CSR 1000v in VMware ESXi Environments
Example
In this example, the cot inject-config command adds Cisco IOS XE commands in text file iosxe_config.txt to the OVA.
$ cat iosxe_config.txt interface GigabitEthernet1 no shutdown ip address 192.168.100.10 255.255.255.0 ! ip route 0.0.0.0 0.0.0.0 GigabitEthernet1 192.168.100.1 $ cot inject-config csr1000v-universalk9.ova \
-o csr1000v-universalk9-customized.ova \
-c iosxe_config.txt
$ cot info csr1000v-universalk9-customized.ova
<.. other output snipped for brevity ..>
Files and Disks: File Size Capacity Device
csr1000v_harddisk.vmdk 71.50 kB 8.00 GB harddisk @ SCSI 0:0
bdeo.sh 52.42 kB
README-OVF.txt 8.53 kB
README-BDEO.txt 6.75 kB
cot.tgz 116.78 kB
csr1000v-universalk9.iso 484.80 MB cdrom @ IDE 1:0
config.iso 350.00 kB cdrom @ IDE 1:1
--------- --------- --------------------
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
88
Loading...