Enable Configure terminal, 14-3 | Cisco Systems CSR 1000V specs

Chapter 14 Configuring Support for Management Using the REST API

Enabling REST API Support Using the Cisco IOS XE CLI

Table 14-3 Cisco CSR 1000V OVA Template Bootstrap Properties Required for REST API Support (Cisco IOS XE Release 3.12S and Later) (continued)

Property	Description

Management IPv4	Configures the IPv4 management default gateway
Gateway (Cisco IOS	address. If using DHCP, enter “dhcp” in the field.
XE Release 3.12S)

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

Enabling REST API Support Using the Cisco IOS XE CLI

•Configuring the Management Interface to Support the REST API (Cisco IOS XE Release 3.11S and Later)

•Configuring HTTPS Support for the REST API Using the Cisco IOS XE CLI

•Disabling REST API Support

•Viewing the REST API Container Status

Configuring the Management Interface to Support the REST API (Cisco IOS XE Release 3.11S and Later)

You need to configure the management interface to support REST API using the Cisco IOS XE CLI in the following situations:

•If you installed the Cisco CSR 1000V using the .iso file.

•If you deployed the Cisco CSR 1000V using an Amazon Machine Image (AMI).

Note If upgrading a REST API configuration from Cisco IOS XE Release 3.10S to Cisco IOS XE Release 3.11S, you must add your REST API configuration to the IOS configuration.

SUMMARY STEPS

1.enable

2.configure terminal

3.interface mgmt-interface

4.ip address mgmt-ipv4-addr

5.no shutdown

6.exit

7.interface virtualportgroup virtual-port-group-number

8.ip unnumbered management-interface

		Cisco CSR 1000V Series Cloud Services Router Software Configuration Guide

	OL-27477-07			14-3
	OL-27477-07			14-3

Image 193

Cisco Systems CSR 1000V manual Enabling Rest API Support Using the Cisco IOS XE CLI, Enable Configure terminal, 14-3

Contents

Cisco Systems, Inc Copyright 2012-2014 Cisco Systems, Inc. All rights reserved Iii N T E N T S ESXi Prerequisites Upgrading the Cisco IOS XE Software Vii Periodic Notification 13-2 Viii Objectives Preface Release Date Change Summary Document Revision History Chapter Title Description Organization Document Conventions Related DocumentationConvention Description Or Ctrl Within an optional element Square brackets enclose default responses to system promptsExamples use the following conventions Processes OL-27477-07 Introduction Cisco CSR 1000V Series Cloud Services Router Overview Cisco CSR 1000V Virtual Form Factor Router Interfaces Virtual Machine Requirements Hypervisor Support Virtual Machines VMware Citrix Kernel Based Virtual Hypervisor vNIC RequirementsESXi XenServer Machine KVM Microsoft Hyper-V VMware ESXi Cisco IOS XE Release 10S, 3.11S 12SNIC Types Supported Citrix XenServer VMXNET3, VIF and Virtio NIC types are para-virtualized NICs Cisco CSR 1000V and Hypervisor Limitations Server Requirements Cisco CSR 1000V Series Software License OverviewIntel Cisco CSR 1000V Version License Type License Term OL-27477-07 OL-27477-07 Gigabit Ethernet x ports only Feature Cisco ASR 1000 Series Cisco CSR 1000V Series Supported Cisco IOS XE Technologies When using the Rest API to manage the Cisco CSR GRE XE Release Technologies Required for See the Following XE Release Technologies Required forSupported Cisco CSR Licenses Supported Documentation Network Management ServicesQoS AAA Waas Managing the Router Using the Cisco CSR 1000V Rest API Managing the Router Using Cisco Configuration ProfessionalManagement Support Cisco CSR 1000V supports the following management options Cisco Unified Computing System UCS Products Related Cisco Product Compatibility Cisco IOS XE Release 3.9S/3.10S/3.11S/3.12S Using Cisco Feature Navigator Using the Software Advisor Using the Software Release Notes OL-27477-07 Using the History Buffer to Recall Commands Using Keyboard ShortcutsKeystrokes Purpose Command Purpose Understanding the Command ModesCommand Mode Access Method Prompt Exit Method Getting Help Finding Command Options Enter the configure terminal Command CommentUsing the interface GigabitEthernet Configuration commands Interface configuration commandsEnter the command that you want to Configure for the interface. This Saving Configuration Changes Using the no and default Forms of Commands This task saves the configuration to Nvram Managing Configuration FilesExample 1 Copying a Startup Configuration File to Bootflash Powering Off the Cisco CSR Filtering the Output of show and more CommandsNvram File Security Cisco CSR 1000V software can install and boot Installation Overview Cisco CSR 1000V Installation Task Workflow Cisco CSR 1000V Installation Options Cisco CSR 1000V Installation FilesObtaining the Cisco CSR 1000V Software Guidelines and Limitations Installation Option VMware ESXi Citrix XenServerMicrosoft Hyper-V Rommon and the Cisco CSR Where to Go Next OL-27477-07 VMware ESXi Support Information Installing the Cisco CSR 1000V in VMware ESXi Environments Cisco CSR 1000V Version Supported vSwitch2lists the virtual machine requirements for the Cisco CSR Virtual CPUs GB virtual diskGB of RAM Or more virtual network interface cards Virtual CPUs, requiring 2.5 GB minimum of RAM Supported VMware Features and Operations Suspend See the following table for more information Supported VMware Features and Operations Networking Features Supported VMware Features and Operations High Availability Client GB RAM Allocation VCPUs Requires Minimum Installation Requirements for VMware ESXiAllocation VCPUs Requires Minimum Deploying the OVA Template to the VM Deploying the Cisco CSR 1000V OVA Template to the VM OL-27477-07 Property Description Enable SCP Server Enables the IOS SCP feature Property Description Tar xvf file.ova bdeo.sh README-BDEO.txt Command Name Parameters Description Enters the ESXi login username Cisco CSR 1000V Cloud Services RouterPw -password Enters the ESXi login password Ipw -iospassword LoginEnters the Cisco IOS XE IOS password required for Remote login See Figure Choose vApp Options Properties Choose vApp Options Advanced Adding Custom Properties for the Cisco CSR Edit Property Settings Window Example of Custom Property Added Power on the VM to boot the Cisco CSR Optional Installing the Cisco CSR 1000V in VMware ESXi Environments Click OK Click Finish Increasing Performance on VMWare ESXi Configurations OL-27477-07 Citrix XenServer Support Information Requirements Cisco IOS XE 3.10S 12S Installation Requirements for Citrix XenServerPage Click Finish KVM Support on OpenStack Kernel Virtual Machine Support Information Requirements Release 3.10S 11S 12S Installation Requirements for KVM Choose Application System Tools Installing the Cisco CSR 1000V in KVM Environments Click Advanced options Creating the Instance Using the KVM Command Nova flavor-create csrflavor 6 4096 0 Creating the Instance Using the OpenStack Command Line Tool Creating the Instance Using the OpenStack Dashboard Virsh nodeinfo Increasing Performance on KVM ConfigurationsVirsh vcpupin csr1000v 1 For more information, see the KVM documentation Modprobe vhost-net OL-27477-07 Microsoft Hyper-V Support Information 1lists the installation requirements for Microsoft HyperV Installation Requirements for Microsoft Hyper-VMicrosoft Hyper-V Requirements Cisco IOS XE 3.12S Prerequisites Configuring the Server Manager SettingsCreating the VM Click Specify Name and Location Configuring the VM Settings Select Network Adapter and click Add Launching the VM to Boot the Cisco CSR Booting the Cisco CSR 1000V as the VM Booting the Cisco CSR 1000V and Accessing the Console OL-27477-07 Accessing the Cisco CSR 1000V Through the VM Console Accessing the Cisco CSR 1000V Console Click the Configuration tab and click Security Profile Creating Serial Console Access in VMware ESXi Creating the Serial Console Access in Microsoft Hyper-V Creating the Serial Console Access in KVMClick on Add Hardware Command or Action Purpose Changing the Console Port Access After InstallationExample Routerconfig# end End Exits configuration mode ExampleRouter# copy systemrunning-config Nvramstartup-config Reload Reloads the operating system OL-27477-07 Upgrading the Cisco IOS XE Software Prerequisites for the Software Upgrade Process Copies the startup configuration file to a server Copy nvramstartup-config ftp rcp tftpConfiguration file copy can serve as a backup copy Enter the destination URL when prompted Copy bootflash ftp rcp tftp Dir bootflash Router# copy tftp bootflash Copy tftp bootflash or Copy rcp bootflash No boot system Use this command to enter global configuration modeLoading the New System Image Loading the New System Image from the Cisco IOS XE Software Exit Exit Copy running-config startup-configWrite Write memory Config-register Loading the New System Image from Grub ModeDo write Do write memory Upgrading the Cisco IOS XE Software Enter the letter c Backup copy Configuration file copy serves as a backup copySystem Write down the name of the system image file Rebooting the Cisco CSR OL-27477-07 10-1 Router# show platform software vnic-if interface-mapping 10-2 10-3 Adding and Deleting Network Interfaces on the Cisco CSR 10-4 Cisco CSR 1000V Network Interfaces and VM CloningCsr1000v# show platform software vnic-if interface-mapping VMware ESXi 10-5 Vlan 10-6 10-7 Cisco CSR 1000V Interfaces Directly Mapped to vSwitch Trunk 10-8 Bit Number Hexadecimal Meaning About Grub Mode and the Configuration Register11-1 Boot Field Accessing Grub ModeEnable Config-register 11-2 Modifying the Configuration Register confreg Using the Grub Menu11-3 11-4 Confreg value 11-5 Displaying the Configuration Register Settings Changing the Configuration Register Settings11-6 12-1 Prerequisites for Call Home Information About Call Home Benefits of Using Call Home12-2 Anonymous Reporting Obtaining Smart Call Home Services12-3 Configuring Smart Call Home Single Command How to Configure Call HomeFollowing sections show detailed or optional configurations 12-4 Call-home reporting anonymous contact-email-addr Mode using the call-home reporting12-5 Configure terminal Service call-home No service call-home Configuring and Enabling Smart Call HomeEnabling and Disabling Call Home 12-6 Phone-number + phone-number Configuring Contact Information12-7 Example Configuring Destination Profiles12-8 12-9 Creating a New Destination Profile Destination address email email-address http url No destination transport-method email httpDestination preferred-msg-format long-text Short-text xml Copying a Destination Profile Configure terminal Call-home12-11 Call -home Setting Profiles to Anonymous ModeAnonymous-reporting-only is set, only crash 12-12 12-13 Subscribing to Alert Groups 12-14 Subscribe-to-alert-group snapshot periodic daily Periodic NotificationHhmm hourly mm interval mm monthly date 12-15 Level Keyword Syslog Level Description Message Severity Threshold12-16 12-17 Configuring Snapshot Command List Priority number Configuring General email Options12-18 12-19 Command or Action Purpose Specifying Rate Limit for Sending Call Home Messages Configure terminal Call-home Rate-limit number12-20 Specifies the proxy server for the Http request Specifying Http Proxy Server12-21 12-22 Configure terminal Call-home No syslog-throttling Configuring Syslog Throttling12-23 Hostname command Configuring Call Home Data Privacy12-24 Sending a Call Home Test Message Manually Sending Call Home Communications ManuallyCall-home test test-messageprofile name Call-home test test-message profile name Sending Call Home Alert Group Messages Manually Call-home send alert-group configuration profileCall-home send alert-group snapshot profile name 12-26 12-27 Submitting Call Home Analysis and Report Requests 12-28 Example 12-29 Prerequisites for Diagnostic Signatures Configuring Diagnostic SignaturesInformation About Diagnostic Signatures 12-30 Diagnostic Signature Downloading Diagnostic Signatures Overview12-31 Diagnostic Signature Events and Actions Diagnostic Signature WorkflowDiagnostic Signature Event Detection 12-32 Diagnostic Signature Variables Diagnostic Signature Actions12-33 Configuring the Call Home Service for Diagnostic Signatures How to Configure Diagnostic Signatures12-34 Destination transport-method email http Mail-server ipv4-addr name priority number12-35 Call-home Diagnostic-signature Configuring Diagnostic SignaturesWhat to Do Next Before You Begin Router# configure terminal Routerconfig# service call-home Configuration Examples for Diagnostic Signatures12-37 Show call-home Displaying Call Home Configuration Information12-38 All destination profiles Examples12-39 Example 2 Call Home Information in Detail 12-40 Callloop 12-41 Router# show call-home profile campus-noc 12-42 Example Call Home Statistics 12-43 Alert Group Trigger Events and Commands Default SettingsParameters Default 12-44 Message Contents Plain Text and XML XML Only Data Item Description Call-Home Message TagType is the product model number from backplane 12-46 12-47 12-48 Sample Syslog Alert Notification in XML Format 12-49 12-50 13-1 Activating Cisco CSR 1000V Licenses 13-2 License Upgrade and Downgrade Scenarios 13-3 Managing the Throughput Level Licenses 13-4 Changing the Maximum Throughput Level 10 100 1000 250 2500 50 500 Platform hardware throughput level MBPlatform hardware throughput level 10000 25000 50000 eval-only 13-6 License-Based Restriction on Aggregate Bandwidth Input 13-758757880 Output Request license new-udi Requesting a New Virtual UDI13-8 Router# show license udi history 14-1 Rest API 14-2 Enable Configure terminal Enabling Rest API Support Using the Cisco IOS XE CLI14-3 No shutdown ActivateInterface virtualportgroup virtualportgroup-number 14-4 14-5 14-6 Enables the transport map to support Https Enables the secure Https serverEnters remote-management configuration mode Disabling Rest API Support Exits remote-management configuration mode Disables support for the Rest APIRouter# show virtual-service detail Viewing the Rest API Container Status Pnsc 14-9 14-10 No shutdown Exit No shutdown Exit Virtual-service csrmgmt15-1 Activate End Enables IP processing on an interface withoutInterface virtualportgroup Assigning it an explicit IP address 15-3 Ip route ip-addresssubnet-maskvirtualportgroup 15-4 Http port command To the Cisco Prime Network Services Controller Host15-5 Exec mode Exits configuration mode and enters privilegedSettings Displays the Cisco CSR 1000V remote management 15-7 No pnsc host ipv4-addrlocal-port number shared-secret 15-8 16-1 Troubleshooting Cisco CSR 1000V VM Issues Troubleshooting VM Performance Issues Troubleshooting Network Connectivity Issues16-2 Click Continue to Product License Registration Voluntarily Rehosting the License to a New VM Figure A-1 License to Initiate-Transfer Screen Figure A-3 License Rehost Target and Options Obtaining a Rehost License if the System Fails Commands Call-home request command Command modes, understanding Call-home reporting commandAaa-authorization call-home Call-home send alert-group command Active call-home IN-2 IN-3 IN-4 IN-5 IN-6