Brocade Vyatta vRouter 5600 EMS App User Guide, 1.1.0

53-1003589-02
18 March 2015
Brocade Vyatta vRouter
5600 EMS
User Guide
Supporting Brocade Vyatta Controller v1.1.0
© 2015, Brocade Communications Systems, Inc. All Rights Reserved.
ADX, Brocade, Brocade Assurance, the B-wing symbol, DCX, Fabric OS, HyperEdge, ICX, MLX, MyBrocade, OpenScript, The Effortless
Network, VCS, VDX, Vplane, and Vyatta are registered trademarks, and Fabric Vision and vADX are trademarks of Brocade
Communications Systems, Inc., in the United States and/or in other countries. Other brands, products, or service names mentioned may be
trademarks of others.
Notice: This document is for informational purposes only and does not set forth any warranty, expressed or implied, concerning any
equipment, equipment feature, or service offered or to be offered by Brocade. Brocade reserves the right to make changes to this document
at any time, without notice, and assumes no responsibility for its use. This informational document describes features that may not be
currently available. Contact a Brocade sales office for information on feature and product availability. Export of technical data contained in
this document may require an export license from the United States government.
The authors and Brocade Communications Systems, Inc. assume no liability or responsibility to any person or entity with respect to the
accuracy of this document or any loss, cost, liability, or damages arising from the information contained herein or the computer programs that
accompany it.
The product described by this document may contain open source software covered by the GNU General Public License or other open
source license agreements. To find out which open source software is included in Brocade products, view the licensing terms applicable to
the open source software, and obtain a copy of the programming source code, please visit http://www.brocade.com/support/oscd.
Contents
Preface..................................................................................................................................... 5
Document conventions......................................................................................5
Text formatting conventions.................................................................. 5
Command syntax conventions.............................................................. 5
Notes, cautions, and warnings.............................................................. 6
Brocade resources............................................................................................ 7
Contacting Brocade Technical Support.............................................................7
Document feedback.......................................................................................... 8
About This Guide.......................................................................................................................9
Intended audience.............................................................................................9
Product applicability.......................................................................................... 9
What is new in this document........................................................................... 9
Supported platforms..........................................................................................9
Brocade Vyatta Controller publications........................................................... 10
About the Brocade Vyatta vRouter 5600 EMS App ...................................................................11
Overview......................................................................................................... 11
Architecture..................................................................................................... 11
Installing and Using the Brocade Vyatta vRouter 5600 EMS App.............................................. 13
Workflow for using the EMS App.................................................................... 13
Installing the EMS App....................................................................................14
Registering devices with the controller............................................................14
Creating an IPsec VPN tunnel........................................................................ 15
Verifying IPsec VPN connectivity.................................................................... 15
Managing configuration by using the YANG UI...............................................16
Managing devices by using the API doc explorer........................................... 16
Unmounting a device...................................................................................... 16
Troubleshooting the Brocade Vyatta vRouter 5600 EMS App....................................................17
Inability to mount a Vyatta 5600 device.......................................................... 17
Vyatta 5600 device does not appear in the device panel................................17
Useful commands for checking VPN tunnel status......................................... 17
Glossary..................................................................................................................................19
Brocade Vyatta vRouter 5600 EMS User Guide
53-1003589-02
3
4
Brocade Vyatta vRouter 5600 EMS User Guide
53-1003589-02
Preface
● Document conventions......................................................................................................5
● Brocade resources............................................................................................................ 7
● Contacting Brocade Technical Support.............................................................................7
● Document feedback.......................................................................................................... 8
Document conventions
The document conventions describe text formatting conventions, command syntax conventions, and
important notice formats used in Brocade technical documentation.
Text formatting conventions
Text formatting conventions such as boldface, italic, or Courier font may be used in the flow of the text
to highlight specific words or phrases.
Format
Description
bold text
Identifies command names
Identifies keywords and operands
Identifies the names of user-manipulated GUI elements
Identifies text to enter at the GUI
italic text
Identifies emphasis
Identifies variables
Identifies document titles
Courier font
Identifies CLI output
Identifies command syntax examples
Command syntax conventions
Bold and italic text identify command syntax components. Delimiters and operators define groupings of
parameters and their logical relationships.
Convention
Description
bold text
Identifies command names, keywords, and command options.
italic text
Identifies a variable.
value
In Fibre Channel products, a fixed value provided as input to a command
option is printed in plain text, for example, --show WWN.
Brocade Vyatta vRouter 5600 EMS User Guide
53-1003589-02
5
Notes, cautions, and warnings
Convention
Description
[]
Syntax components displayed within square brackets are optional.
Default responses to system prompts are enclosed in square brackets.
{x|y|z}
A choice of required parameters is enclosed in curly brackets separated by
vertical bars. You must select one of the options.
In Fibre Channel products, square brackets may be used instead for this
purpose.
x|y
A vertical bar separates mutually exclusive elements.
<>
Nonprinting characters, for example, passwords, are enclosed in angle
brackets.
...
Repeat the previous element, for example, member[member...].
\
Indicates a “soft” line break in command examples. If a backslash separates
two lines of a command input, enter the entire command at the prompt without
the backslash.
Notes, cautions, and warnings
Notes, cautions, and warning statements may be used in this document. They are listed in the order of
increasing severity of potential hazards.
NOTE
A Note provides a tip, guidance, or advice, emphasizes important information, or provides a reference
to related information.
ATTENTION
An Attention statement indicates a stronger note, for example, to alert you when traffic might be
interrupted or the device might reboot.
CAUTION
A Caution statement alerts you to situations that can be potentially hazardous to you or cause
damage to hardware, firmware, software, or data.
DANGER
A Danger statement indicates conditions or situations that can be potentially lethal or
extremely hazardous to you. Safety labels are also attached directly to products to warn of
these conditions or situations.
6
Brocade Vyatta vRouter 5600 EMS User Guide
53-1003589-02
Brocade resources
Brocade resources
Visit the Brocade website to locate related documentation for your product and additional Brocade
resources.
You can download additional publications supporting your product at www.brocade.com. Select the
Brocade Products tab to locate your product, then click the Brocade product name or image to open the
individual product page. The user manuals are available in the resources module at the bottom of the
page under the Documentation category.
To get up-to-the-minute information on Brocade products and resources, go to MyBrocade. You can
register at no cost to obtain a user ID and password.
Release notes are available on MyBrocade under Product Downloads.
White papers, online demonstrations, and data sheets are available through the Brocade website.
Contacting Brocade Technical Support
As a Brocade customer, you can contact Brocade Technical Support 24x7 online, by telephone, or by email. Brocade OEM customers contact their OEM/Solutions provider.
Brocade customers
For product support information and the latest information on contacting the Technical Assistance
Center, go to http://www.brocade.com/services-support/index.html.
If you have purchased Brocade product support directly from Brocade, use one of the following methods
to contact the Brocade Technical Assistance Center 24x7.
Online
Telephone
E-mail
Preferred method of contact for nonurgent issues:
Required for Sev 1-Critical and Sev
2-High issues:
[email protected]
• My Cases through MyBrocade
•
Continental US: 1-800-752-8061
• Software downloads and licensing •
tools
Europe, Middle East, Africa, and
Asia Pacific: +800-AT FIBREE
(+800 28 34 27 33)
• Knowledge Base
•
For areas unable to access toll
free number: +1-408-333-6061
•
Toll-free numbers are available in
many countries.
Please include:
•
Problem summary
•
Serial number
•
Installation details
•
Environment description
Brocade OEM customers
If you have purchased Brocade product support from a Brocade OEM/Solution Provider, contact your
OEM/Solution Provider for all of your product support needs.
• OEM/Solution Providers are trained and certified by Brocade to support Brocade® products.
• Brocade provides backline support for issues that cannot be resolved by the OEM/Solution Provider.
Brocade Vyatta vRouter 5600 EMS User Guide
53-1003589-02
7
Document feedback
• Brocade Supplemental Support augments your existing OEM support contract, providing direct
access to Brocade expertise. For more information, contact Brocade or your OEM.
• For questions regarding service levels and response times, contact your OEM/Solution Provider.
Document feedback
To send feedback and report errors in the documentation you can use the feedback form posted with
the document or you can e-mail the documentation team.
Quality is our first concern at Brocade and we have made every effort to ensure the accuracy and
completeness of this document. However, if you find an error or an omission, or you think that a topic
needs further development, we want to hear from you. You can provide feedback in two ways:
• Through the online feedback form in the HTML documents posted on www.brocade.com.
• By sending your feedback to [email protected]
Provide the publication title, part number, and as much detail as possible, including the topic heading
and page number if applicable, as well as your suggestions for improvement.
8
Brocade Vyatta vRouter 5600 EMS User Guide
53-1003589-02
About This Guide
● Intended audience.............................................................................................................9
● Product applicability.......................................................................................................... 9
● What is new in this document........................................................................................... 9
● Supported platforms..........................................................................................................9
● Brocade Vyatta Controller publications........................................................................... 10
Intended audience
This guide is intended for experienced system and network administrators. You must have a basic
understanding of Linux operating systems and hypervisor environments.
Product applicability
This guide applies to Brocade Vyatta vRouter 5600 EMS app version 1.1.0.
What is new in this document
Brocade Vyatta vRouter 5600 EMS app version 1.1.0 is the first release.
Information that was modified:
• In Troubleshooting the Brocade Vyatta vRouter 5600 EMS App, removed instructions for deleting an
IPsec VPN tunnel. The functionality is not supported.
Supported platforms
Brocade Vyatta vRouter 5600 EMS app version 1.1.0 is supported on the following systems:
• Ubuntu 14.04 operating system
• Brocade Vyatta Controller version 1.1.1
• Brocade Vyatta 5600 vRouter version 3.2.1R4
Brocade Vyatta vRouter 5600 EMS User Guide
53-1003589-02
9
Brocade Vyatta Controller publications
Brocade Vyatta Controller publications
The publications for the Brocade Vyatta Controller are as follows:
•
•
•
•
•
10
Brocade Vyatta Controller User Guide
Brocade Vyatta Controller Quick Start Guide
Brocade Vyatta Controller Release Notes
Brocade Vyatta Path Explorer User Guide
Brocade Vyatta vRouter 5600 EMS User Guide
Brocade Vyatta vRouter 5600 EMS User Guide
53-1003589-02
About the Brocade Vyatta vRouter 5600 EMS App
● Overview......................................................................................................................... 11
● Architecture..................................................................................................................... 11
Overview
An element management system (EMS) consists of systems and applications for managing network
elements on the network element-management layer of the Telecommunications Management Network
model.
Brocade Vyatta vRouter 5600 EMS is an app built on top of the Brocade Vyatta Controller to manage
the Vyatta 5600 devices.
You must purchase a separate license to access the EMS app.
Using the EMS app, you can perform the following tasks:
• Manage all configuration of Vyatta 5600 devices by using the NETCONF protocol and data stores
that are modeled in the YANG user interface.
• Build IPsec VPN tunnels between Vyatta 5600 routers, using either IPv6 protocol or IPv4 protocol.
Architecture
Brocade Vyatta vRouter 5600 EMS is an app built on top of the Brocade Vyatta Controller. You can
access the EMS app by using the controller user interface after you install the app.
The Vyatta router uses the Brocade vPlane technology that enables hardware-like routing performance
in a software-based network appliance. Traditionally, packet processing in Linux has run in the kernel
space. However, with the vPlane architecture, packet processing is run in the Linux user space. Using
the vPlane architecture and leveraging the Intel Data Plane Development Kit (Intel DPDK), the Vyatta
router delivers breakthrough levels of performance. Depending on configuration, one or two cores are
dedicated to each interface that allow for the ability to run the core or cores at 100-percent efficiency
when processing packets. For more information about the Brocade vRouter, refer to Brocade Vyatta
Basic System Guide at http://www.brocade.com/downloads/documents/html_product_manuals/vyatta/
vyatta_5600_manual/wwhelp/wwhimpl/js/html/wwhelp.htm
The EMS app communicates with the Brocade Vyatta Controller by using the RESTCONF interface.
The controller communicates with Vyatta 5600 devices by using the NETCONF protocol. You can
interact with the EMS app through the GUI. For more information, refer to the architecture diagram that
follows.
Brocade Vyatta vRouter 5600 EMS User Guide
53-1003589-02
11
About the Brocade Vyatta vRouter 5600 EMS App
FIGURE 1 EMS App Architecture
12
Brocade Vyatta vRouter 5600 EMS User Guide
53-1003589-02
Installing and Using the Brocade Vyatta vRouter 5600 EMS
App
● Workflow for using the EMS App.................................................................................... 13
● Installing the EMS App....................................................................................................14
● Registering devices with the controller............................................................................14
● Creating an IPsec VPN tunnel........................................................................................ 15
● Verifying IPsec VPN connectivity.................................................................................... 15
● Managing configuration by using the YANG UI...............................................................16
● Managing devices by using the API doc explorer........................................................... 16
● Unmounting a device...................................................................................................... 16
Workflow for using the EMS App
Ensure that you have installed the following products before using the EMS app.
• Brocade Vyatta Controller version 1.1.1.
For information about installing the Brocade Vyatta Controller, refer to Brocade Vyatta Controller
Quick Start Guide.
• Brocade Vyatta 5600 vRouter version 3.2.1R4.
To install the Brocade 5600 vRouter, refer to the documentation at http://www.brocade.com/
downloads/documents/html_product_manuals/vyatta/vyatta_5600_manual/wwhelp/wwhimpl/js/html/
wwhelp.htm.
The workflow for using the EMS app is as follows.
1. Install the EMS for each controller VM.
For more information about installing the EMS, see Installing the EMS App on page 14.
2. Log in to the Brocade Vyatta Controller GUI and select Vyatta vRouter 5600 EMS.
3. Manually register the Brocade Vyatta 5600 vRouters for all the sites with the Brocade Vyatta
Controller.
For more information about registering devices, see Registering devices with the controller on page
14.
4. Manage configurations by using one or both of the following methods:
• Manage configuration of the device by using the YANG UI.
For more information about managing device configuration, refer to Managing configuration by
using the YANG UI on page 16.
• Create IPsec VPN tunnels between multiple registered Vyatta 5600 devices by using the tunnel
builder.
For more information about creating an IPsec VPN tunnel, refer to Creating an IPsec VPN tunnel
on page 15.
5. Disconnect the device.
For more information about unmounting a device, refer to Unmounting a device on page 16.
Brocade Vyatta vRouter 5600 EMS User Guide
53-1003589-02
13
Installing the EMS App
.
Installing the EMS App
This section provides the installation instructions for the Brocade Vyatta vRouter 5600 EMS app. To
access the EMS on the Brocade Vyatta Controller GUI, you must install the app separately.
Ensure that you have installed the following before you install the EMS:
• Brocade Vyatta Controller version 1.1.1.
• Brocade Vyatta 5600 vRouter version 3.2.1R4.
To install the EMS, perform the following steps.
1. Install the Brocade Vyatta Controller by using the installation instructions.
For more information about installing the controller, refer to Brocade Vyatta Controller Quick Start
Guide.
2. Download the EMS app zip file.
3. Enter the following command to unzip the EMS app zip file to the /opt directory.
unzip -o bvc-app-vyattaems-1.1.0.zip -d /opt
4. Enter the following command to go to the /opt/bvc directory.
cd /opt/bvc
5. Enter the following command to install the EMS app.
./install
This command installs the EMS app. Refresh the Brocade Vyatta Controller GUI to see the app in
the application pane.
Registering devices with the controller
You must manually register the NETCONF routers with the controller, as the process is not
automated.
1. From a remote or local system, open a supported browser and enter the login URL http://
<controller-ip>:9000 to access the Brocade Vyatta Controller UI.
The controller-ip is the IP address of the computer, on which the Brocade Vyatta Controller is
installed.
2. Log in with the following credentials: a username of admin, and a password of admin.
3. Select Vyatta vRouter 5600 EMS in the application pane.
The Vyatta vRouter 5600 EMS window is displayed.
4. In the Vyatta vRouter 5600 EMS content pane, enter a Device Name for the vRouter VM and the
NETCONF IP Address and Port Number of the VM.
5. Enter the User ID and Password, which the controller uses to connect to the vRouter.
6. Click Mount Device.
The controller stores the configuration locally on its VM. If the mount operation is successful, the
interfaces for the vRouter are displayed under Mounted Devices.
7. Repeat steps 4 through 6 for all the vRouters in your controller cluster.
The Mounted Device section displays the names and interfaces of all the vRouters.
14
Brocade Vyatta vRouter 5600 EMS User Guide
53-1003589-02
Creating an IPsec VPN tunnel
Creating an IPsec VPN tunnel
An IPsec VPN tunnel between two data centers enables secured communication.
Ensure that you perform the following steps before you create an IPsec VPN tunnel:
• Identify the data centers for which you want to run the EMS.
• Ensure that all the data centers have Internet connectivity.
• Create a VM for each instance of the edge router that you want to install. Typically, each site has one
edge router.
• Install the Brocade 5600 vRouter as an edge router on the VM for each of the sites.
• Ensure that the edge routers of the data centers prohibit unsecured connection between two clients
that are located at two different sites. To verify that your data center prohibits unsecured connection,
ping the IP address of the edge router of the other data center. You should receive the failure
message.
• Keep a record of the NETCONF IP addresses for all the vRouter VMs.
TABLE 1 Example Record of NETCONF IP Addresses
Site
vRouter VM Name
vRouter VM NETCONF IP Address
Site A
Site B
Site C
To create an IPsec VPN tunnel between two data centers, perform the following steps.
1. Select Vyatta vRouter 5600 EMS.
2. In the Vyatta vRouter 5600 EMS content pane, select the two devices between which you want to
create an IPsec VPN tunnel.
3. Click Add IPv6 Tunnel to toggle between creating IPv4 and IPv6 tunnels.
4. Click Create Tunnel.
If you log in to the VM at the first site and ping the VM for the second tunnel, the communication
should be successful.
Verifying IPsec VPN connectivity
To verify that you have set up the IPsec VPN tunnel correctly between two data centers, it is essential
to test the connection before and after you set up the tunnel.
Ensure that you locate the IP address of the edge router of the data center to which you are building the
IPsec VPN tunnel from your current data center.
Ping the IP address of the edge router of the other data center again, after you create an IPsec VPN
tunnel as described in Creating an IPsec VPN tunnel on page 15.
Brocade Vyatta vRouter 5600 EMS User Guide
53-1003589-02
15
Managing configuration by using the YANG UI
You should receive a successful ping message.
Managing configuration by using the YANG UI
When you mount the Vyatta 5600 device with the EMS app, you can manage it by using the YANG UI
tab in the controller GUI. To manage the Vyatta 5600 device, follow the steps given in the next section.
1. Click the YANG UI tab in the controller GUI.
Wait until the YANG UI loads all modules.
2. Expand opendaylight-inventory > nodes > node{id} in the content pane.
The Vyatta 5600 devices that are registered with the EMS app are displayed.
3. To view data for a particular module (for example, vyatta-interfaces), click mount > interfaces >
GET.
4. Select Show Preview.
The data for the interface is displayed in JSON format.
5. To edit any value, make the changes and click PUT for the changes to take effect.
Managing devices by using the API doc explorer
1. Select Vyatta vRouter 5600 EMS.
A table displays the Vyatta 5600 devices that are registered with the EMS app.
2. Select a device and click </>.
The API doc explorer page is displayed.
3. Click Mounted Resources.
A list of registered devices is displayed.
4. Select a Vyatta device that you want to manage.
A list of all YANG modules that the device supports and the corresponding RESTCONF operations
is displayed.
5. Select an operation to manage the device.
Unmounting a device
When you unmount a device, the device registration becomes obsolete and you cannot manage the
router thereafter. Re-register the device , if you want to be able to manage the device again.
The device must be registered in the Brocade Vyatta vRouter 5600 EMS. For more information about
registering a device, see Registering devices with the controller on page 14.
1. Select Vyatta vRouter 5600 EMS.
A table displays the Vyatta 5600 devices that are registered with the EMS app.
2. Select a device and click X.
The X is the unmount icon.
The device registration becomes obsolete and you cannot manage the router thereafter.
16
Brocade Vyatta vRouter 5600 EMS User Guide
53-1003589-02
Troubleshooting the Brocade Vyatta vRouter 5600 EMS App
● Inability to mount a Vyatta 5600 device.......................................................................... 17
● Vyatta 5600 device does not appear in the device panel................................................17
● Useful commands for checking VPN tunnel status......................................................... 17
Inability to mount a Vyatta 5600 device
If you cannot mount a Vyatta 5600 device, perform the following steps by logging in to the device and
typing the commands that follow:
• Ensure that the NETCONF service is enabled on the device. To do so, log in to the device and enter
the following commands in the order shown:
1. configure
2. show service
• If NETCONF is not listed, then enter the following commands in the order shown:
1. set service netconf
2. commit
3. save
Vyatta 5600 device does not appear in the device panel
If you have mounted a Vyatta 5600 device and the device does not appear in the device panel, click the
Refresh button.
The device may not appear in the device panel because sometimes the device panel does not register
properly.
Useful commands for checking VPN tunnel status
The following commands are useful for checking VPN tunnel status on a device:
•
•
•
•
•
show
show
show
show
show
vpn
vpn
vpn
vpn
vpn
ipsec
ipsec
ipsec
ipsec
ipsec
Brocade Vyatta vRouter 5600 EMS User Guide
53-1003589-02
status
sa detail
statistics
sa statistics peer
sa peer
17
Useful commands for checking VPN tunnel status
18
Brocade Vyatta vRouter 5600 EMS User Guide
53-1003589-02
Glossary
Brocade Vyatta
Controller
Platform
A server-and-user platform process that contains the functionality of the
base controller.
Brocade Vyatta
Controller app
An app that runs on the Brocade Vyatta Controller Platform and provides
additional usage cases, features, or both.
For example: bvc-1.1.1.zip, bvc-dependencies-1.1.1.zip
For example: bvc-app-pathexplorer-packaging-1.1.0.zip, bvc-appvyattaems-packaging-1.1.0.zip
Brocade Vyatta
Controller
extension
An extension that modifies or configures the Brocade Vyatta Controller
Platform or app. Typically, an extension is bundled with the Brocade
Vyatta Controller Platform, a Brocade Vyatta Controller app, or another
Brocade product.
For example: bvc-ext-l2switch-noflood-packaging-1.0.0.zip
Brocade Vyatta vRouter 5600 EMS User Guide
53-1003589-02
19
Glossary
20
Brocade Vyatta vRouter 5600 EMS User Guide
53-1003589-02