Guide to Vyatta Documentation

Transcription

1 VYATTA, INC. System Guide to Documentation Suite Shoreway Road Belmont, CA vyatta.com VYATTA 1 (US and Canada)

2 COPYRIGHT Copyright , Inc. All rights reserved. reserves the right to make changes to software, hardware, and documentation without notice. For the most recent version of documentation, visit the web site at vyatta.com. PROPRIETARY NOTICES is a registered trademark of, Inc. VMware, VMware ESX, and VMware server are trademarks of VMware, Inc. XenServer, and XenCenter are trademarks of Citrix Systems, Inc. All other trademarks are the property of their respective owners. RELEASE DATE: March 2012 DOCUMENT REVISION. R6.4 v01 RELEASED WITH: R6.4.0 PART NO. A

3 System Documentation Map 1 Documentation Map Software Documentation Overview Documents Guide to Documentation Quick Start Guide to Software Licensing IPv6 Support Command Changes Cross-Document Search Installing and Upgrading Software Deployment Options Creating and Using a LiveCD Hard Disks and Persistent Devices VMware XenServer Red Hat KVM Amazon Machine Image System and Services Basic System Remote Management Connection Management Services NAT Using the CLI Working with Config System Mgmt User Mgmt Logging SSH Telnet Web GUI SNMP Connection Tracking Flow Accounting DHCP DHCPv6 DNS Web Caching LLDP Bridging Interfaces LAN Interfaces WAN Interfaces Ethernet Pseudo-Ethernet Loopback VLAN Ethernet Bonding Wireless Input Serial Serial Testing DSL Wireless Modem Encapsulations and Tunnels Encapsulations PPP-Based Encapsulations Tunnels Cisco HDLC Frame Relay Classical IPoA Bridged Ethernet PPP PPPoE PPPoA Multilink PPP GRE Tunnels IP-in-IP Tunnels SIT Tunnels

4 System Documentation Map 2 Routing Basic Routing RIP RIPng OSPF BGP Routing Policies Security Firewall Security VPN IPv4 Firewall IPv6 Firewall Zone-Based Firewall IPS Web Filtering IPsec Site-to-Site VPN Remote Access VPN OpenVPN QoS QoS QoS Availability High Availability WAN Load Balancing VRRP Clustering Stateful NAT and Firewall Failover RAID 1 Configuration Synchronization

5 System Documentation Map 3 API Documentation API Documents Remote Access API Documentation 514 Quick Start Sheet Reference 600 Quick Start Sheet 1600 Quick Start Sheet Series 2500 Getting Started Rack Installation 2600 Quick Start Sheet Series 3500 Getting Started

6 System Documentation Library Overview 4 Documentation Library Overview The technical library includes the following documents: Software Documentation Overview Documents Guide to Documentation System Quick Start Guide Guide to Software Licensing Guide to IPv6 Support Guide to CLI Changes Cross Document Search Utility A graphical map of product documentation, plus a brief description of each guide. Instructions for installing the software, introduction to user interface options, and configuration scenarios to get you started. A description of s software licensing model and Entitlement infrastructure. s support for features of the IPv6 protocol. The Command Changes document assists you in tracking changes made to the CLI over time, listing any deprecated or obsoleted commands and mapping renamed commands onto their new names. To facilitate easy searching and sorting, this document is delivered as a spreadsheet. The cross document search index lets you search for a word or phrase across the entire all the documents in the software documentation set. To use the search index, extract the zip file in the same folder as the PDF software guides. Open the PDX file, enter the search phrase in the search bar, and click Search. Software Installation and Upgrades Installing the System: Deployment Options Installing the System: Creating and Using a LiveCD Installing and Upgrading: Hard Disks and Persistent Devices Installing and Upgrading: VMware Installing and Upgrading: XenServer Installing and Upgrading: RedHat KVM Options for deploying the system. Detailed procedures for creating and using a LiveCD. Detailed procedures for installing and upgrading s system image for persistent devices. Detailed procedures for installing and upgrading s system image for VMware. Detailed procedures for installing and upgrading s system image for XenServer. Detailed procedures for installing and upgrading s system image for KVM on the Red Hat Kernel based Virtual Machine (KVM) hypervisor.

7 System Documentation Library Overview 5 Installing the System/User Guide: Amazon Machine Interface Detailed procedures for installing, upgrading, and operating s Amazon Machine Image (AMI) within the Amazon Web Services cloud. System and Services Basic System Reference Guide Remote Management Reference Guide Connection Management Reference Guide Services Reference Guide Bridging Reference Guide NAT Reference Guide Using the CLI, working with configuration, system management, user management, and logging. SSH, Telnet, Web GUI Access, and SNMP. Connection tracking and flow accounting. DHCP, DHCPv6, DNS, Web caching, and LLDP. Bridging. NAT. Interfaces LAN Interfaces Reference Guide WAN Interfaces Reference Guide Encapsulations Reference Guide PPP Based Encapsulations Reference Guide Tunnels Reference Guide Ethernet interfaces, pseudo Ethernet interfaces, the loopback interface, VLAN interfaces, bridge interfaces and bridge groups, Ethernet link bonding, Wireless, and Input interfaces. Basic serial interface configuration, T1, T3, E1, E3, synchronous serial, serial loopback tests, BERTs, DSL interfaces, and wireless modem interfaces. Cisco HDLC, Frame Relay, Classical IPOA, and RFC 2684 bridged Ethernet. PPP, PPPoE, PPPoA, and multilink PPP. GRE, IP in IP, and SIT tunnels. Routing Basic Routing Reference Guide RIP Reference Guide RIPng Reference Guide OSPF Reference Guide Commands for showing routing and forwarding information; static routes. Routing Information Protocol (RIP) commands and configuration examples. Routing Information Protocol next generation (RIPng) commands and configuration examples. OSPF (Open Shortest Path First) commands and configuration examples.

8 System Documentation Library Overview 6 BGP Reference Guide Routing Policies Reference Guide Border Gateway Protocol (BGP) commands and configuration examples. Routing policies. Security Firewall Reference Guide Security Reference Guide VPN Reference Guide IPv4 firewall, IPv6 firewall, and zone based firewall. Intrusion detection and prevention and web filtering. IPsec site to site VPN, IPsec and PPTP remote access VPN, and OpenVPN. QoS QoS Reference Guide Traffic shaping, scheduling algorithms, and congestion avoidance. Availability High Availability Reference Guide WAN load balancing, clustering, VRRP, stateful NAT and firewall failover, RAID 1, and configuration synchronization. API Documentation API Documents Remote Access API How to remotely control a device via its programming interface.

9 System Documentation Library Overview 7 Documentation Quick Start Sheet 514 Reference A fold out sheet for getting the 514 up and running. How to install and set up 514 hardware Quick Start Sheet 600 A quick guidefor getting the 600 up and running. Provides reference information for 600 hardware Quick Start Sheet 1600 A quick guidefor getting the 1600 up and running. Provides reference information for 1600 hardware. Series 2500 Series 2500 Getting Started Guide Series 2500 Rack Installation Guide Series 2500 Owner s Manual Lists the major features of Series 2500 hardware and explains how to quickly install and configure the system. Explains how to set up the rack and rack mount Series 2500 hardware. Provides reference information for Series 2500 hardware Quick Start Sheet 2600 A quick guidefor getting the 2600 up and running. Provides reference information for 2600 hardware. Series 3500 Series 3500 Getting Started Guide Series 3500 Owner s Manual Lists the major features of Series 3500 hardware and explains how to quickly install and configure the system. Provides reference information for Series 3500 hardware.