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
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:
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
Cisco CSR 1000v Series Cloud Services Router Overview
Managing the Router Using the Cisco IOS XE REST API