Disabling Rest API Support, 14-7 | Cisco Systems CSR 1000V specification

Chapter 14 Configuring Support for Management Using the REST API

Enabling REST API Support Using the Cisco IOS XE CLI

	Command or Action	Purpose

Step 5	secure-server	Enables the secure HTTPS server.
	Example:
	router(config)# secure-server

Step 6	transport type persistent webui input transport-map-name	Enables the transport map to support HTTPS.
	Example:
	router(config)# transport type persistent webui
	input https-webui

Disabling REST API Support

Beginning with Cisco IOS XE Release 3.11S, you can disable REST API support on the remote management interface. Support for the REST API is enabled by default.

SUMMARY STEPS

1.enable

2.configure terminal

3.remote-management

4.no restful-api

5.end

DETAILED STEPS

	Command or Action	Purpose

Step 1	enable	Enables privileged EXEC mode.
		• Enter your password if prompted.
	Example:
	router> enable

Step 2	configure terminal	Enters global configuration mode.
	Example:
	router# configure terminal

Step 3	remote-management	Enters remote-management configuration mode.
	Example:
	router(config)# remote-management

		Cisco CSR 1000V Series Cloud Services Router Software Configuration Guide

	OL-27477-07			14-7
	OL-27477-07			14-7

Image 197

Cisco Systems CSR 1000V manual Disabling Rest API Support, Enables the secure Https server, 14-7

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 ESXi XenServer Machine KVM Microsoft Hyper-V Hypervisor vNIC RequirementsVMware Citrix Kernel Based Virtual 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 Intel Cisco CSR 1000V Series Software License OverviewServer Requirements 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 Supported Cisco CSR Licenses Supported Documentation XE Release Technologies Required forSee the Following QoS ServicesNetwork Management 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 Keystrokes Purpose Using Keyboard ShortcutsUsing the History Buffer to Recall Commands Command Mode Access Method Prompt Exit Method Understanding the Command ModesCommand Purpose Getting Help Finding Command Options Using the interface GigabitEthernet Command CommentEnter the configure terminal 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 Example 1 Copying a Startup Configuration File to Bootflash Managing Configuration FilesThis task saves the configuration to Nvram Nvram File Security Filtering the Output of show and more CommandsPowering Off the Cisco CSR Cisco CSR 1000V software can install and boot Installation Overview Cisco CSR 1000V Installation Task Workflow Obtaining the Cisco CSR 1000V Software Cisco CSR 1000V Installation FilesCisco CSR 1000V Installation Options 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 2lists the virtual machine requirements for the Cisco CSR Supported vSwitchCisco CSR 1000V Version 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 Allocation VCPUs Requires Minimum Installation Requirements for VMware ESXiGB RAM Allocation 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 vcpupin csr1000v 1 Increasing Performance on KVM ConfigurationsVirsh nodeinfo For more information, see the KVM documentation Modprobe vhost-net OL-27477-07 Microsoft Hyper-V Support Information Microsoft Hyper-V Requirements Cisco IOS XE 3.12S Installation Requirements for Microsoft Hyper-V1lists the installation requirements for Microsoft HyperV Creating the VM Configuring the Server Manager SettingsPrerequisites 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 Click on Add Hardware Creating the Serial Console Access in KVMCreating the Serial Console Access in Microsoft Hyper-V Example Changing the Console Port Access After InstallationCommand or Action Purpose 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 Do write Do write memory Loading the New System Image from Grub ModeConfig-register 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 Csr1000v# show platform software vnic-if interface-mapping Cisco CSR 1000V Network Interfaces and VM Cloning10-4 VMware ESXi 10-5 Vlan 10-6 10-7 Cisco CSR 1000V Interfaces Directly Mapped to vSwitch Trunk 10-8 11-1 About Grub Mode and the Configuration RegisterBit Number Hexadecimal Meaning Boot Field Accessing Grub ModeEnable Config-register 11-2 11-3 Using the Grub MenuModifying the Configuration Register confreg 11-4 Confreg value 11-5 11-6 Changing the Configuration Register SettingsDisplaying the Configuration Register Settings 12-1 Prerequisites for Call Home 12-2 Benefits of Using Call HomeInformation About Call Home 12-3 Obtaining Smart Call Home ServicesAnonymous Reporting Configuring Smart Call Home Single Command How to Configure Call HomeFollowing sections show detailed or optional configurations 12-4 12-5 Mode using the call-home reportingCall-home reporting anonymous contact-email-addr Configure terminal Service call-home No service call-home Configuring and Enabling Smart Call HomeEnabling and Disabling Call Home 12-6 12-7 Configuring Contact InformationPhone-number + phone-number 12-8 Configuring Destination ProfilesExample 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 12-11 Configure terminal Call-homeCopying a Destination Profile 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 12-16 Message Severity ThresholdLevel Keyword Syslog Level Description 12-17 Configuring Snapshot Command List 12-18 Configuring General email OptionsPriority number 12-19 Command or Action Purpose 12-20 Configure terminal Call-home Rate-limit numberSpecifying Rate Limit for Sending Call Home Messages 12-21 Specifying Http Proxy ServerSpecifies the proxy server for the Http request 12-22 12-23 Configuring Syslog ThrottlingConfigure terminal Call-home No syslog-throttling 12-24 Configuring Call Home Data PrivacyHostname command 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 12-31 Diagnostic Signatures OverviewDiagnostic Signature Downloading Diagnostic Signature Events and Actions Diagnostic Signature WorkflowDiagnostic Signature Event Detection 12-32 12-33 Diagnostic Signature ActionsDiagnostic Signature Variables 12-34 How to Configure Diagnostic SignaturesConfiguring the Call Home Service for Diagnostic Signatures 12-35 Mail-server ipv4-addr name priority numberDestination transport-method email http Call-home Diagnostic-signature Configuring Diagnostic SignaturesWhat to Do Next Before You Begin 12-37 Configuration Examples for Diagnostic SignaturesRouter# configure terminal Routerconfig# service call-home 12-38 Displaying Call Home Configuration InformationShow call-home 12-39 ExamplesAll destination profiles 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 14-3 Enabling Rest API Support Using the Cisco IOS XE CLIEnable Configure terminal 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 15-1 No shutdown Exit Virtual-service csrmgmtNo shutdown Exit 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 15-5 To the Cisco Prime Network Services Controller HostHttp port command 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 16-2 Troubleshooting Network Connectivity IssuesTroubleshooting VM Performance Issues 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