Plexxi HCN Plexxi Switch Software Administrator Guide using Linux and Plexxi CLI Release 4.0.0

Transcription

1 Plexxi HCN Plexxi Switch Software Administrator Guide using Linux and Plexxi CLI Release Document Version 2 May 22, Innovative Way - Suite 3322 Nashua, NH Tel PLEX (7539)

2 Legal Notices The information contained herein is subject to change without notice. Plexxi, the Plexxi logo, and LightRail are registered trademarks, and Plexxi HCN, Plexxi Control and Plexxi Connect are trademarks of Plexxi, Inc. in the United States and other countries. Other product or service name may be trademarks or service marks of others. No part of this documentation may be reproduced in any form or by any means or used to make any derivative work (such as translation, transformation, or adaptation) without written permission from Plexxi, Inc. Plexxi, Inc. reserves all rights of copyright in this documentation. PLEXXI, INC. PROVIDES THIS DOCUMENTATION AS IS, WITHOUT WARRANTY, TERM, OR CONDITION OF ANY KIND, EITHER IMPLIED OR EXPRESSED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES, TERMS, OR CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY, NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE. Plexxi, Inc. reserves the right to make changes to equipment design or program components described in this documentation, as progress in engineering, manufacturing methods, or other circumstances may warrant. No responsibility is assumed for the use of Plexxi, Inc. software or hardware, all rights, obligations and remedies related to which are as set forth in the applicable sales and license agreements. Plexxi, Inc. 100 Innovative Way - Suite 3322 Nashua, NH Tel: PLEX (7539) Published May 22, 2018 Printed in United States of America. Copyright 2018 Plexxi, Inc. All rights reserved. The Plexxi Switch system is classified as a class 1 telecommunications laser product employing embedded class 1 lasers and complies with the following: THIS PRODUCT COMPLIES WITH FDA RULE 21 CFR SUBCHAPTER J IN EFFECT AT DATE OF MANUFACTURE. PRODUCT COMPLIES WITH 21 CFR AND PRODUIT CONFORME SELON LE SOUS CHAPITRE J DU DOCUMENT FDA RÈGLE 21 CFR EN VIGUEUR LORS DE LA DATE DE FABRICATION. PRODUIT CONFORME SELON 21CFR ET Electrotechnical Commission (IEC) , This product is classified as a: CLASS 1 LASER PRODUCT APPAREIL À LASER DE CLASSE 1 This unit is intended to be installed in a Restricted Access Location only with access only by trained personnel. Warning: The primary hazards of exposure to invisible laser radiation from an optical fiber communications system are: Damage to the eye by viewing an unterminated optical fiber or fiber optic connector. Damage to the eye from invisible laser radiation from viewing a cut fiber or a broken fiber. Never attempt to view optical connectors that may be emitting laser energy and always avoid possible exposure to invisible optical laser radiation. Using optical fiber scopes or magnifying lenses may increase the possibility for an eye hazard. It is recommended that you use an optical power meter to determine if there is optical laser radiation present or use a remote video display inspection tool to inspect connectors. Plexxi Switch Administrator Guide using Linux and Plexxi CLI,

3 Table of Contents Legal Notices... 2 Welcome...12 Related Documentation...13 Contacting Plexxi Support Switch Management Connections...14 Ports Serial Console Port SSH through Management Port SSH Session opened from Plexxi Control Logging into the switch User Accounts Initial Switch Setup...15 Serial Console Running px-setup Configuring the Plexxi Control IP Address on the DHCP Server Connecting through the Management Interface Changing the admin User Password Accessing the Plexxi CLI Configuring LightRails Saving the Configuration Upgrading Plexxi Switch Software Plexxi Linux Utilities for Switch Configuration...18 px-adduser px-hostname px-log-bundle px-lspart px-package-check px-setup px-ssl-install px-sslgen px-topology Managing Plexxi Switch Linux User Accounts and Authentication Methods...27 Local Switch Authentication Adding a Local User Using the Plexxi px-adduser Utility Accessing the Plexxi CLI TACACS+ Authentication for a Switch Overview Configuring TACACS+ Authentication on a Switch TACACS+ PAM setup TACACS+ NSS Configuration RADIUS Authentication for a Switch Overview Configuring RADIUS Authentication on a Switch Plexxi Switch Administrator Guide using Linux and Plexxi CLI,

4 Enabling RADIUS LDAP Authentication for a Switch Overview Configuring LDAP Authentication for a Switch Enabling the Authentication Method for a Switch Debian Linux Commands for Switch Configuration...35 Configuring Clocks Manually Setting the Time and Date Changing the Time Zone Setting Time Once with NTP Configuring NTP Configuring the IP Domain Configuring the Management Interface Configuring the IP Address of the Management Interface Configuring the MTU Size of the Management Interface Enabling and Disabling the Management Interface Configuring a VLAN on the Management Interface Configuring IP Routes Configuring SNMP Groups Communities MIB Views SNMP v3 User-Based Security Model Copying Files to a Switch Configuring SSH Keys on a Switch Regenerating SSH Host Keys on the Switch Starting or Stopping the SSH service on the Switch Making SSH Persistent on the Switch Saving Configuration Changes...41 Saving Configuration Changes Checking the Current Configuration Handling Files...42 Handling Files from the Debian Linux Prompt Copying Files from a Remote System Handling Files from the Plexxi CLI running-config and startup-config Copy, Move, and Delete Examples File Copy with URL Upgrading the Plexxi Switch Software to Release Preparing to Upgrade from a Pre Release Upgrading the Switches Implementing the IS-IS Protocol Running a Fit In-Band Management...45 Overview Configuring In-Band Management Related Plexxi CLI Commands inband-management config dhcp Plexxi Switch Administrator Guide using Linux and Plexxi CLI,

5 inband-management config ip inband-management delete inband-management gw add show inband-management Configuring LightRails...49 Overview LightRail LightRail 2 (Switch 3eq) LightRail 3 (Switch 3eq) User Interface and Workflow Details CLI Commands to Configure LightRails Switch 2e DCI mode...51 Operation Modes of operation Switch2e DCI CLI Command: fabric redirect Switch 2e I/O Panel Ports BGP-EVPN...54 About BGP-EVPN Configuring BGP-EVPN on Each Plexxi Switch address-family exit-address-family neighbor activate neighbor peer-group neighbor remote-as Routed Port Interface...59 Overview Considerations Viewing the Configured LAGs on a Plexxi Switch Prerequisites Configuring a Routed Port Interface Creating the Interface Assigning an IP Address to the Interface Verifying the Configuration Spine Switch Fabric...62 CLI Commands to Configure the Spine Switch Fabric Configure the Spine LightRail Configure the Fabric Speed for LightRail Type 1 or 2 on the Spine Switch Configure the Fabric Egress Rate for Fabric Ports on the Spine Switch Plexxi CLI Modes...63 Opening the Plexxi CLI Shell Entering the CLI Modes Entering the EXEC Mode Entering the PRIV-EXEC Mode Entering the CONFIG Mode Entering the CONFIG-LINE Mode Exiting the CONFIG-LINE Mode Exiting the CLI Modes Returning to the Previous CLI Mode Returning to the PRIV-EXEC Mode Plexxi Switch Administrator Guide using Linux and Plexxi CLI,

6 Exiting Plexxi Shell to Bash CLI Command Reference Exec mode...66 clear access-list clear counters clear ip clear ipv clear mac sw-table debug bgp debug ip debug mrd debug nsm debug ospf debug pim debug pip debug prd disable enable exit quit help logout no no debug all ping quit reset log show access-list show bgp show cli show clock show crossbars show cutthru show debugging show fabric show flow show hardware show history show hold-policy show hosts show interface show interface summary show ip show ip arp show ip dhcp-relay show ip domain-list show ip domain-name show ip fastpath statistics show ip host show ip igmp snooping show ip interface show ip name-server show ip route Plexxi Switch Administrator Guide using Linux and Plexxi CLI,

7 show lacp show lacp lag show lag show lag lacp show lag IFNAME vlan show list show lldp show lldp local-info show locate-led show log show mrib show neighbor-discovery show nsm show ntp show post show privilege show qinq svlan show qsfp show router-channel show router-id show sflow show system resources show system uptime show timezone show topography show transceivers show translation tvlan show users show version show virtual-routers show vlan ssh telnet terminal trace-attachment traceroute undebug CLI Command Reference PRIV-EXEC mode...90 boot toggle clear arp-cache clear controller address clear controller config clear cores clear hold clear ip route kernel clear mac hw-table clear policer statistics configure (terminal) controller set copy FILE copy running-config Plexxi Switch Administrator Guide using Linux and Plexxi CLI,

8 copy startup-config copy URL cutthru dci-behavior delete FILE delete startup-config dir disable enable fabric-encap create fabric clear-fabric-id fabric-encap delete fabric east-egress-rate (Switch 2e) fabric east-speed (Switch 2e) fabric egress-rate (Switch 3eq) fabric learn-fabric-id fabric lightrails fabric protocol-change fabric redirect (for Switch 2e) fabric redirect (for Switch 2, 2s, 2p, 2sp) fabric speed (Switch 3eq) fabric west-egress-rate (Switch 2e) fabric west-speed (Switch 2e) flow hold hold-policy hold IFNAME inband-management config port inband-management config dhcp inband-management config ip inband-management delete install <FILE> lldp port IFNAME receive locate-led logout migrate-data move FILE mstat mtrace ptp qsfp config quit reload (rescue) rpi create rpi delete show boot show controller show debugging snmp show fabric show fabric-encap show file Plexxi Switch Administrator Guide using Linux and Plexxi CLI,

9 show flow show fsat show history show hosts show inband-management show install show interface show l2-isis show loop-detection-stats show mac hw-table show mac sw-table show nsm client show peers show process show psat show running-config show startup-config show system cores show tech-support show topography show topology residual show topology vlan show user-defined-path show users support log-bundle verify FILE CLI Command Reference CONFIG mode access-list arp banner motd bgp debug debug nsm do <command> dump bgp enable password exit quit fib retain help interface ip forwarding ip route line console line vty log file max-fib-routes max-static-routes maximum-access-list maximum-paths no route-map <tag> Plexxi Switch Administrator Guide using Linux and Plexxi CLI,

10 router bgp router ospf router-channel router-id service advanced-vty service password-encryption service terminal-length show cli show list show running-config synce CLI Command Reference CONFIG-LINE mode exec-timeout end exit quit CTRL-D help history login privilege level show cli show list show running-config Appendix A CLI Help Output Modifiers Repeat a Show Command Appendix B Troubleshooting Switch Log Test Network Connectivity Assess System Health Display Running Processes Hardware Status Power Supply Details Temperature Sensor Readings Fan Status Appendix C Working with Plexxi Care Support Opening the PRIV-EXEC Mode Combining show Command Output Redirecting show Command Output Bundling Log Files Specifying the Number of Days to Include in Log Output Specifying a Time Copying Plexxi Switch Core Files Checking for Core Files Copying a Core File to Another Network Host Copying a Core File to Local User Disk Space Verifying a Core File in its Original Location Deleting Core Files Plexxi Switch Administrator Guide using Linux and Plexxi CLI,

11 Plexxi Switch Administrator Guide using Linux and Plexxi CLI,

12 Welcome This document describes switch administration tasks and commands/functions that are performed at either the Debian Linux Bash prompt or at a Plexxi configuration command line interface (CLI) prompt. The CLI is used for initial switch set up, some feature configurations, and troubleshooting. You can use the CLI to access information available from Plexxi Control and to display system status. Although some Plexxi Switch configurations are performed using the Plexxi CLI, most switch configuration tasks are performed using either the Plexxi Control graphical user interface (GUI) or the Plexxi Connect GUIs. Configuration parameters that are set at the Linux prompt as outlined in this document include: Clocks management interface NTP SNMP switch user management Configuration parameters that are set at the Plexxi CLI prompt as described in this document include: Switch 2e DCI L2 Fabric Link Encapsulation In-band Management Redirection Configuration parameters that are set using the Plexxi Control GUI are described in the Plexxi Control Online Help and include: VLANs Affinities User-Defined Paths Switch ports Switch software upgrades Plexxi Switch Administrator Guide using Linux and Plexxi CLI,

13 Related Documentation The following additional documentation supports this release: Plexxi Compatibility Matrix, Version 10 or greater. The Plexxi Compatibility Matrix contains versionspecific software and hardware support information as well as cable and transceiver support information. Plexxi Release Notes, Release Plexxi Control Installation, Upgrade and Administration Guide, Release Plexxi Control Online Help is available while logged into the Plexxi Control UI Except for the online help, this documentation is available on the Resources > Technical Publications page of Contacting Plexxi Support Plexxi Technical Support services are available to answer your questions and to make sure that your software and hardware continue to operate properly. You can contact Plexxi Support at: (US/Canada toll-free) (US/International). Plexxi Switch Administrator Guide using Linux and Plexxi CLI,

14 1 Switch Management Connections Ports You can connect to a Plexxi Switch to perform switch management using the following methods: connect via SSH through the management port open a terminal session from Plexxi Control connect a console system to the console port on the switch. IMPORTANT: If you are performing an initial setup of the switch, refer to 2, Initial Switch Setup. Serial Console Port The serial console may be needed for part of the initial switch setup, for troubleshooting, or for general switch management using Linux and the Plexxi CLI. For serial access, the console system must be connected to the console port on the switch. To connect to the serial console port, the following settings are needed: Kbps 8 data bits 1 stop bit No Parity SSH through Management Port If a switch has undergone the initial switch setup and if the management port is connected to a network for management, you can SSH remotely through the switch s management port. IMPORTANT: If you are performing an initial setup of the switch, refer to 2, Initial Switch Setup. SSH Session opened from Plexxi Control You can open an SSH session from Plexxi Control as described in the Plexxi Control Online Help, which is accessible from the Plexxi Control UI (User Interface). Logging into the switch When you connect to the switch, you are prompted for a username and password. The default values for the pre-configured administrator account are: username: admin password: plexxi When you log in, you start in your home directory at /home/<username>. At the shell prompt, you can: perform switch setup using px-setup utilities perform some switch configuration tasks using the Plexxi CLI User Accounts For information on managing Plexxi user accounts from Linux, refer to the next chapter. Plexxi Switch Administrator Guide using Linux and Plexxi CLI,

15 2 Initial Switch Setup When you initially install a switch, you need to open a console connection to any switch in the fabric, then run the px-setup command to configure the appropriate switch(es) as described in the sections that follow. Additionally, you can specify a new password for access to Linux on any new switches, and for switch 3eq, define LightRail configuration. Serial Console The serial console may be needed for part of the initial switch setup, for troubleshooting, or for general switch management using Linux and the Plexxi CLI. For serial access, the console system must be connected to the console port on the switch. To connect to the serial console port, the following settings are needed: Kbps 8 data bits 1 stop bit No Parity Running px-setup px-setup is a Plexxi utility that simplifies Plexxi switch setup by eliminating the need to edit configuration files and restart services on the Plexxi Switch. The utility queries administrators for information, then configures the IP or hostname of the Plexxi Control software, time zone, network address, default gateway, SNMP management, and several network services, including NTP and DNS. The px-setup commands require root/sudo privilege to modify core services. For example, logged into the switch as admin: $ sudo px-setup To setup all switches and all network characteristics for a new install, use px-setup without arguments: $ sudo px-setup For detailed information about the px-setup command, refer to the following section in px-setup on page 22. Note: Instead of specifying the IP address or hostname of the Plexxi Control server using the px-setup command, refer to the next section to configure the IP address or hostname of the Plexxi Control server on the DHCP server. You only need to perform this step for the first Plexxi switch installed in the fabric. Configuring the Plexxi Control IP Address on the DHCP Server Rather than configuring the IP address or hostname of the Plexxi Control server on a Plexxi switch via the px-setup-controller CLI command, administrators can configure the IP address or hostname of the Plexxi Control server on the DHCP server. Follow the instructions in this section for the first Plexxi switch being deployed in your fabric. Note: These instructions assume that Plexxi Control has already been deployed on a Plexxi Control server. For an ISC (Internet Systems Consortium) DHCP server, include the following option lines in the DHCP server's configuration file: option plexxi-control-address code 240 = text; option plexxi-control-address = ; Plexxi Switch Administrator Guide using Linux and Plexxi CLI,

16 You can define either an IP address or hostname. The Plexxi switch will obtain the IP address or hostname of the Plexxi Control server from the DHCP server when the switch is booted or rebooted. The DHCP server will send the code 240 value to the Plexxi Switch in the DHCP Reply message. The Plexxi switch will then configure the specified IP address or hostname for communicating with the Plexxi Control server. IMPORTANT: If an IP address or hostname for the Plexxi Control server has already been configured on the Plexxi switch using the px-setup-controller CLI command, the IP address or hostname received in the DHCP Reply message will not override it. Once the configuration is complete, you can remove the option lines above from the DHCP server s configuration file, because the configured IP address or hostname of the Plexxi Control server will persist even through upgrades and will only be removed by explicitly removing it using the px-setupcontroller (or equivalent) command on the Plexxi switch. Connecting through the Management Interface Connect to the switch using the ssh command. This requires that the MGMT port on the switch be connected and that you know the IP address of the switch management port (the address you just configured). Connect to the switch using ssh and log in using the default credentials. For example: ssh admin@ipaddress Reply as prompted; the default administrator login is: Username: admin Password: plexxi This puts you at the Debian Linux prompt on the switch in the /home/admin directory. Changing the admin User Password You can change the password for the Linux admin user on any new switches using the Linux passwd command while logged in as admin and at the Linux prompt on the switch: $ passwd Accessing the Plexxi CLI Access the Plexxi CLI as follows: 1. Open the Plexxi CLI Shell. At the Bash prompt, enter the following sudo command and then enter the password for admin: admin@switch:~$ sudo px-shell This opens the EXEC Mode prompt: switch> For example: admin@plexxi1:~$ sudo px-shell [sudo] password for admin:... plexxi1> Plexxi Switch Administrator Guide using Linux and Plexxi CLI,

17 2. Enter the PRIVILEGED EXEC mode, from the EXEC mode, enter the enable command. For example, on switch Plexxi1: plexxi1> enable plexxi1# The prompt changes from > to #. Configuring LightRails Configure the LightRails as described in Chapter 10, Configuring LightRails. Saving the Configuration An asterisk preceding the prompt indicates that the configuration has changed and not saved. In the PRIV-EXEC mode (# prompt), save the new configuration settings to the switch, enter the command: *plexxi1# copy running-config startup-config Building configuration... [OK] plexxi1# Upgrading Plexxi Switch Software You might need to upgrade to the latest version of the switch software when you initialize the switch for the first time. If you are not sure, verify with your Plexxi representative. Plexxi Switch Administrator Guide using Linux and Plexxi CLI,

18 3 Plexxi Linux Utilities for Switch Configuration Some Plexxi switch specific configuration settings are accomplished using Plexxi Linux utilities as outlined in the sections that follow. IMPORTANT: Man pages are available for Plexxi px- utilities. Running Plexxi Linux Utilities To run the Plexxi Linux utilities: 1. Connect to the Plexxi switch using ssh and log in using the default credentials using the following command: ssh For example: ssh In the above command, you can specify the hostname rather than the IP address, as follows: ssh For example: ssh 2. Reply as prompted. The default administrator login is: Username: admin Password: plexxi 3. This puts you at the Debian Linux prompt on the switch in the /home/admin directory. 4. Change directory to the root directory: cd / 5. At the prompt, enter a Plexxi utility command. For example: $ px-topology --info 6. To get a man page for a Plexxi utility command, enter the following command: $ man command_name For example: $ man px-adduser px-adduser Add a User The px-adduser utility enables you to easily create accounts that adhere to Plexxi switch user roles. It is accessible in the switch Bash environment; it is not available from the px-shell CLI. Note: It is not mandatory that you use this utility to create Plexxi switch user accounts - it just makes it easier. px-adduser <username> px-adduser [--user-role administrator operator viewer] [--full-name <name>] <user_name> px-adduser [--disabled-login] <user_name> px-adduser [-h --help] Helper utility for creating local user accounts that adhere to Plexxi user roles. Plexxi Switch Administrator Guide using Linux and Plexxi CLI,

19 Options -h, --help Display help for this command. --user-role role Specify the role for this account: administrator, operator or viewer. --full-name name Indicate the full name of this user or any comment for the account. --disabled-login Create the account without prompting for the initial password. Issuing this command with only the user_name argument prompts you to enter the user role, full name and password for this new account. The optional parameters listed above can be passed to avoid entering settings interactively. Note: The password cannot be passed on the command line. You can use the disabled-login option to create the account initially disabled, then later, use the passwd command to set the initial password and enable the account. User Roles Plexxi supports the following user roles: Administrator - This role has the highest privileges on the system. It equates, indirectly, to superuser access. User accounts of this role have: o o Membership in group px_administrator; this group has sudo access to all system commands Default shell is /bin/bash Operator - This is the second highest privilege level. It allows for configuration changes in px-shell, but is more limited for the rest of the system. It has: o o Membership in group px_operator; this group has sudo access only to px-shell. Default shell is /bin/bash Viewer - This is the least privileged role. Users with this role are only allowed unprivileged access to px-shell and no access to Bash. It includes: o o Examples Membership in group px_viewer; this group has no sudo privileges Default shell is /bin/px-shell The following command, you are prompted for role, full name and initial password. $ sudo px-adduser nemo The following command generates no prompts and creates an operator account that is disabled: $ sudo px-adduser --user-role operator --full-name "Dory fish" --disabled-login dory The following command displays Help for the px-adduser command: $ sudo px-adduser -help Exit Status This utility essentially calls the useradd command, followed by the passwd command (unless opted out). If either of these exhibit an error, their status is propagated out by this utility. See useradd(8) and passwd(1) for more details on their status codes. Scripting It may be desirable to script the creation of accounts. This can be accomplished by using the optional -- user-role and --full-name arguments to pass the information normally prompted for. The password cannot be passed on the command line - it could be visible to other users in the process listing. Instead, the --disabled-login option can be passed, and the account gets created in an initially disabled state. Later on, /usr/bin/passwd can be used to set the initial password and enable the account. Plexxi Switch Administrator Guide using Linux and Plexxi CLI,

20 px-hostname Configure the Switch Host Name The standard Linux hostname command does not make a persistent change to the switch hostname. To make a persistent switch hostname change, use the Plexxi px-hostname utility from BASH. When using the px-hostname command to change the hostname of the switch, the command must be run as 'root' (with 'sudo'). Note: The host name becomes part of the Linux and Plexxi CLI command prompts on the next login. px-hostname px-hostname <new_host_name> [-y --yes-restart] px-hostname -h --help Options: -h, --help -y, --yes-restart Print help for this command. Proceed with the hostname change without prompting. When you configure the switch hostname, various services are restarted. Therefore, you will be prompted to continue. You can avoid the prompt by entering y or --yes-restart as a command argument. px-hostname with no arguments returns the current active hostname. px-hostname with a new hostname persistently applies the new hostname to the switch. px-log-bundle Generate log bundle The px-log-bundle utility allows users to retrieve a log bundle from a specified switch. The output file has the format HOSTNAME-YYYYMMDD-HHMM-sw-log-bundle.tar.gz and contains log files for a switch that are newer than the specified or default (24 hours) time. px-log-bundle [-h] [-v] [-d days -H hours -f [YYYY][MM][DD]hhmm] Optional Arguments -h --help -d --days=(days) Display help for this command. Include files newer than number of days before now. -f --format=[yyyy][mm][dd]hhmm Include files newer than the specified date/time: YYYY MM DD hhmm 4-digit year 2-digit month 2-digit day Hour and minute -H --hours=(hours) Include files newer than number of hours before now. -v --verbose Run in verbose mode. Can be used with [-d days -H hours -f [YYYY][MM][DD]hhmm] or with no other options (which collects logs from the previous 24 hours). Plexxi Switch Administrator Guide using Linux and Plexxi CLI,

21 Examples The following command generates a log bundle containing data from the last 36 hours: $ px-log-bundle -H 36 The following command generates a log bundle containing data from the last 30 days: $ px-log-bundle -d 30 The following command generates a log bundle containing data starting at 1:00 April 27, 2018: $ px-log-bundle -f px-lspart Display Install Partition Information The /usr/bin/px-lspart utility lists the installed software version for each of the install partitions (A and B). It also indicates which partition is currently running ( r is shown next to the partition) and which partition is currently the default boot partition ( b is shown next to the partition). px-lspart px-lspart -h --help Options -h, --help Display a help summary. Notes If the alternate partition is not mounted, an error is given indicating as such. The command relies on /alt being mounted. Also, the version strings shown are those for the install package that was installed to the partition (either via ONIE or Plexxi upgrade). If you need to know more granular information about specific package versions, try the px-package-check or dpkg commands. px-package-check List Installed Software Packages The Plexxi px-package-check utility returns a report of any packages that have been added, removed, or updated since the current partition was installed. px-package-check [-h] [-e] [-i] [-r] [-u] Optional Arguments -h or --help Show help for this command. -e or --errors List error conditions. Returns the name, version, and status. -i or --installed List packages installed since initial install. Returns the name and version. -r or --removed List packages removed since initial install. Returns the name and version. -u or --upgraded List packages upgraded since initial install. Returns the name, original version and current version. If no arguments are passed, the px-package-check utility lists the following: packages that do not appear to be fully installed. packages that have been added since the initial installation packages that have been removed since the initial installation Plexxi Switch Administrator Guide using Linux and Plexxi CLI,

22 packages that have upgraded (or otherwise changed version) since the initial installation This utility does not detect reinstallation or reconfiguration of packages. Note: You can also refer to the 'dpkg-query' command and the /var/log/dpkg.log file. px-setup Switch Setup px-setup is a Plexxi utility that simplifies Plexxi switch setup by eliminating the need to edit configuration files and restart services on the Plexxi Switch. The utility queries administrators for information, then configures the IP or hostname of the Plexxi Control software, time zone, network address, default gateway, SNMP management, and several network services, including NTP and DNS. The px-setup commands require root/sudo privilege to modify core services. For example, logged into the switch as admin: $ sudo px-setup To setup all switches and all network characteristics for a new install, use px-setup without arguments: $ sudo px-setup To setup a new Plexxi switch added to an existing Plexxi fabric, use px-setup and define the switch by its MAC address: $ sudo px-setup t MAC_Address To configure a specific parameter in an existing Plexxi fabric, use px-setup with the protocol/network characteristic to configure. For example, to configure time zone: $ sudo px-setup-tz Note: px-setup uses UTC by default for time zone. Plexxi recommends that you use UTC for Plexxi Switch and Plexxi Control. IMPORTANT: Plexxi recommends that Plexxi Connect, Plexxi Control and Plexxi Switches all be connected to a reliable NTP service. Determining Your Operating Environment Determine whether the installed switches will use static IP addresses or DHCP. For static IP, run px-setup without arguments to configure all parameters. $ sudo px-setup For DHCP, determine which services DHCP configures in your environment, and which services you configure with px-setup. Refer to the below. px-setup px-setup [-t switch,,switch] px-setup --help Plexxi Switch Administrator Guide using Linux and Plexxi CLI,

23 Command px-setup px-setupcontroller px-setup-hostaddr px-setup-tz px-setup-ntp px-setup-dns px-setup-snmp Function Entering px-setup with no arguments queries for all service information and applies the configuration to all Plexxi switches on the fabric. You can answer 'n' to omit service queries as they are prompted. With no arguments, it configures ALL switches discovered by census info; in other words, all switches properly connected and detected on the Plexxi fabric. Configure the fully-qualified host name or IP address of the Plexxi Control server. This value was assigned when you deployed Plexxi Control on the Plexxi Control host. Configure the host name and management IP address for each switch being configured. Set the time zone for each switch being configured. Note: px-setup uses UTC by default for time zone. Plexxi recommends that you use UTC for Plexxi Switch and Plexxi Control. Configure NTP for each switch being configured. Configure DNS for each switch being configured. Configure SNMP for each switch being configured. Options -t MAC,,MAC Specify one or more switches to configure. This is a comma delimited (no spaces) list of MAC address which uniquely identify the Plexxi switches. If one or more switches is specified using the -t, only the listed switches are configured and only questions which apply to those switches will be posed. This option is recommended to configure an individual switch or multiple switches of a similar class (city, service-type, etc). --help Display a help summary. Examples $ sudo px-setup This asks a series of questions about all detectable switches and common services, then applies the configuration to the switches. $ sudo px-setup -t 01:02:03:aa:bb:cc This prompts and collects configuration information for a specified switch (01:02:03:aa:bb:cc) identified by its unique base MAC address. The configuration is applied to the specified switch only. $ sudo px-setup -t 01:02:03:aa:bb:cc,55:44:ff:ee:bb:00 Specifies two switches. The utility queries about all services common to the specified switches, then applies the configuration on the specified switches. $ sudo px-setup-ntp Queries only about NTP, then applies the configuration to all Plexxi switches. Plexxi Switch Administrator Guide using Linux and Plexxi CLI,

24 $ sudo px-setup-ntp -t 01:02:03:aa:bb:cc Queries only about NTP, then applies the configuration to only the specified switch. $ sudo px-setup --help Displays a help summary. Notes The px-setup commands create a set of backup files of the puppet manifests it utilizes to distribute and apply the configuration. These are stored in the /var/opt/px-setup-backups directory in a subdirectory which uses a date-time format such as _ This directory is populated with configuration data (in an intermediary state) on all systems where the configuration is to be applied. To prevent disk over-usage, a limited set of backup files is retained. If an automated backup system is in place, it is advisable to collect the data in these directories. The px-setup commands keep the output simple and clean. More detailed debug information can be found in /var/log/px-setup.log. This log is only produced on the switch where px-setup was executed. It is unique per switch and not shared or distributed. px-ssl-install Install an SSL Certificate and Keys The px-ssl-install utility enables administrators to install their own custom certificates and key pairs on the Plexxi switch. This tool places the files in the correct place in the file system and restarts the Plexxi client so that the client can import the certificate and keys. px-ssl-install <cert> <key> px-ssl-install -h --help Where: <cert> <key> -h, --help The path and name for the certificate file. Needs to be in curl format. The path and name for the key file. Needs to be in curl format. Display help for this command. Examples The following command installs from local files: $ px-ssl-install file:///<certfile>.pem file:///<keyfile>.pem The following command installs from a Web server: $ px-ssl-install px-sslgen Generate a Pair of Self-Signed SSL Keys The px-sslgen utility generates two self-signed SSL keys for the Plexxi switch, one private key and one public key. All fields in the px-sslgen command are optional. The tool generates SSL certificates with default values. px-sslgen -o --output <output> px-sslgen -c --country <country> px-sslgen -st --state <state> px-sslgen -l --location <location> px-sslgen -org --organization <organization> px-sslgen -cn --cname <cname> px-sslgen -em -- < > Plexxi Switch Administrator Guide using Linux and Plexxi CLI,

25 px-sslgen -a --altname <alternate name> px-sslgen -ex --expires <expires> px-sslgen -fp --fileprefix <fileprefix> px-sslgen h --help Optional Arguments -o, --output -c, --country -st, --state -l, --location -org, --organization -cn, --cname -em, -- -a, --altname -ex, --expires -fp, --fileprefix -h, --help The --output option specifies an optional output location. The default location is simple1/. The --country option specifies a value for the optional country field in SSL keys. The default value is US. The --state option specifies a value for the optional state field in SSL keys. The default value is New Hampshire. The --location option specifies a value for the optional location field in SSL keys. The default value is Nashua. The --organization option specifies a value for the optional organization field in SSL keys. The default value is Plexxi. The --cname option specifies a value for the optional cname field in SSL keys. The default value is the system hostname. The -- option specifies a value for the optional field in SSL keys. The default value is support@plexxi.com. The --altname option specifies a value for the optional alternate name field in SSL keys. The default value is derived from the system hostname, FQDN, and interface IP addresses. The --expires option specifies a value for when the certificates expire in the expires field in SSL keys. The default value is seconds (5 years). The --fileprefix option specifies a prefix used when generating output files. The default value is server. Display help for this command. Examples The following command generates two SSL keys, one private and one public, in the default directory simple1/ : $ px-sslgen The following command generates two SSL keys, one private and one public, in the current directory: $ px-sslgen -output "./" px-topology View and Diagnose the Plexxi Fabric Topology The px-topology command can be used to view and diagnose the Plexxi fabric (topology). px-topology -s --show residual px-topology -s --show vlan [vlan <VLAN>] [root <ROOT>] px-topology -t --trace residual px-topology -t --trace vlan <VLAN> [root <ROOT>] px-topology -t --trace attachments px-topology -v --validate px-topology -e --state residual px-topology -e --state vlan px-topology -c --control px-topology -i --info px-topology -h --help Plexxi Switch Administrator Guide using Linux and Plexxi CLI,

26 Optional Arguments -s, --show -t, --trace -v, --validate -e, --state -c, --control -i, --info -h, --help vlan The --show option displays the currently active paths from this switch to one or more root switches in the Plexxi network. The --trace option sends trace packets from this switch to destination switches on the residual or VLAN (ISO) topologies. When tracing, you can specify the "attachments" argument to simulate actual lookup failures to follow attachments from this switch to the root switches the attachments reside on. The --validate option uses trace packets to test if the topology is healthy. It outputs a status message that indicates success or failure of the topology. The --state option shows the state of active and backup paths for either the residual or VLAN (ISO) topologies. Failures are indicated in the output; for example, switch or uplink failures. Show the active list of Plexxi switches. Show information on the state of the last fitting transaction. Display help for this command. The vlan (ISO) option filters results for a specific VLAN or root switch. Plexxi Switch Administrator Guide using Linux and Plexxi CLI,

27 4 Managing Plexxi Switch Linux User Accounts and Authentication Methods Plexxi Switch supports the following user authentication methods: Local switch authentication TACACS+ RADIUS LDAP These methods are described in this chapter. In addition, this chapter describes how to enable the configuration authentication method. Plexxi Switch Administrator Guide using Linux and Plexxi CLI,

28 Local Switch Authentication Local Linux and Plexxi CLI users can be created on each Plexxi switch. Linux users can be created on the switch platform using the Plexxi px-adduser utility. Each Plexxi switch user must be a member of one of the following pre-defined groups which give them their privileges: IMPORTANT: Only an Administrator can create users. px_administrator This user Role provides root access to the Plexxi Switch through pre-arranged sudoers config file. Upon login, any px_administrator user has full administrator access to all Linux commands and utilities, via sudo. px_operator This Role provides normal, unprivileged access to the Linux system. It cannot, for example, create or edit user accounts. Upon login, a px_operator user has elevated sudo privileges for 'px-shell' only. In this way, the user has full configuration ability within the Plexxi CLI. px_viewer - This user Role provides only viewing access in the Plexxi CLI, and NO access to Linux. Adding a Local User Using the Plexxi px-adduser Utility Important: This is the preferred utility to use when adding a user. Any Administrator can add a local user at the Linux prompt on the switch using the px-adduser utility: 1. Create the user by issuing this command and following the prompts: $ sudo px-adduser <username> Important: The px-adduser utility is described in detail in Chapter 4, in the section, Adding a User - px-adduser. This section also provides options on how to script px-adduser without user interaction. 2. Respond to the prompts, assigning the appropriate group (px_administrator, px_operator, or px_viewer) Accessing the Plexxi CLI As an Administrator To access the Plexxi CLI, at the Linux prompt on the switch, a user with Administrator role must execute the command: $ sudo px-shell In the Plexxi CLI, this user has full configuration privileges. Upon exiting the Plexxi CLI, this user is returned to their Linux shell until logout. As an Operator To access the Plexxi CLI, at the Linux prompt on the switch, a user with Operator role must execute the command: $ sudo px-shell In the Plexxi CLI, this user has full configuration privileges. Upon exiting the Plexxi CLI, this user is returned to their Linux shell with read-only privileges until logout. As a Viewer Upon login, a user with Viewer role is placed directly in the Plexxi CLI with Viewer privileges. Viewer users do not have Linux access. Plexxi Switch Administrator Guide using Linux and Plexxi CLI,

29 TACACS+ Authentication for a Switch Overview TACACS+ support allows Switch users to be authenticated using TACACS+ using the standard Linux Pluggable Authentication Modules (PAM) infrastructure. In Release 3.0, this needs to be configured directly on each Plexxi switch. When enabled, users that log in to the Switch platform using ssh, will be authenticated using an external TACACS+ server, and placed in an Administrator, Operator or Viewer group as defined in the TACACS server configuration. The groups refer to the privileges as documented in the Local AAA feature. Configuring TACACS+ Authentication on a Switch To configure TACACS for PAM authentication on a switch: 1. Configure TACACS+ PAM as described in TACACS+ PAM Setup, below. 2. If you are going to support remote users (as opposed to local users in /etc/passwd), then configure TACACS+ NSS as described in TACACS+ NSS Configuration page if you are using NSS, then add tacplus to the passwd and group lines in /etc/nsswitch.conf. For example: # /etc/nsswitch.conf # # Example configuration of GNU Name Service Switch functionality. # If you have the `glibc-doc-reference' and `info' packages installed, try: # `info libc "Name Service Switch"' for information about this file. passwd: compat tacplus group: compat tacplus 4. Enable TACACS+ using the pam-auth-update utility as described in Enabling the Authentication Method for a Switch, page if you are using TACACS+ NSS, restart the NSCD service: $ sudo service nscd restart TACACS+ PAM setup For PAM, configure the /etc/tacplus.conf file with the following parameters: Variable Description Valid values server TACACS+ server. May have more than one entry. server=hostname server=ip_addr server=hostname:port server=ip_addr:port secret TACACS+ server secret. May have more than one entry. Each entry will be applied to the servers defined before the entry. secret=plain-text-string login TACACS+ authentication service. login=pap login=chap login=login DEFAULT is pap (suggest login=login) Plexxi Switch Administrator Guide using Linux and Plexxi CLI,

30 Variable Description Valid values service TACACS+ service for authorization and accounting Don't care but the protocol wants it to be defined protocol TACACS+ protocol for authorization and accounting Don't care but the protocol wants it to be defined timeout Timeout value in seconds The default value is 5 seconds Example /etc/tacplus.conf server= secret=mysecret login=login service=linuxlogin protocol=ssh TACACS+ NSS Configuration For NSS, configure the /etc/nss_tacplus.conf file with the following parameters: Field name Description Example server Comma separated list of TACACS+ servers server server :49 server , secret secret used to authenticate to the TACACS+ server secret=plain-text-string timeout timeout in seconds The default value is 5 seconds debug enable debug logging service service to query on TACACS+ server This is where UID and ROLE need to be defined protocol The default value is ssh Example /etc/nss_tacacs.conf server secret mysecret timeout 2 service linuxlogin protocol ssh Plexxi Switch Administrator Guide using Linux and Plexxi CLI,

31 RADIUS Authentication for a Switch Overview Remote Authentication Dial-In User Service (RADIUS) is a networking protocol that provides centralized Authentication, Authorization, and Accounting (AAA) management for users who connect and use a network service. RADIUS support allows Switch users to be authenticated using RADIUS and the standard Linux Pluggable Authentication Modules (PAM). When enabled, users who log in to the Switch using SSH are authenticated using an external RADIUS server and placed in an Administrator, Operator or Viewer group as defined in the RADIUS server configuration. The groups refer to the privileges as documented in the Local AAA feature. Configuring RADIUS Authentication on a Switch This feature needs to be configured directly on each Plexxi switch. Configure the RADIUS PAM module via the file /etc/pam_radius_auth.conf. Each line of the file consists of: <server_address>[:port] <secret> <timeout> Where: server_address is either an IPv4 address or a FQDN. port or server port, is optional. secret is the RADIUS server secret. timeout is the server timeout value in seconds. Example Multiple lines may be provided to use multiple RADIUS servers. For example: /etc/pam_radius_auth.conf :500 mysecret 2 radius.plexxi.com plexxi_secret 5 Enabling RADIUS Enable RADIUS using the pam-auth-update utility as described in Enabling the Authentication Method for a Switch, page 34. Plexxi Switch Administrator Guide using Linux and Plexxi CLI,

32 LDAP Authentication for a Switch Overview LDAP allows Switch users to be authenticated using LDAP using the standard Linux Pluggable Authentication Modules (PAM) infrastructure. In Release 3.0, this needs to be configured directly on each switch. When enabled, users that log in to a switch using ssh will be authenticated using an external LDAP server, and placed in an Administrator, Operator or Viewer group as defined in the LDAP server configuration. Configuring LDAP Authentication for a Switch When LDAP is configured, the nsswitch.conf file must be edited to use LDAP. In this case, LDAP is configured for passwd, group and shadow: # /etc/nsswitch.conf # Example configuration of GNU Name Service Switch functionality. # If you have the `glibc-doc-reference' and `info' packages installed, try: # `info libc "Name Service Switch"' for information about this file. passwd: ldap compat group: ldap compat shadow: ldap compat gshadow: files hosts: files dns networks: files protocols: db files services: db files ethers: db files rpc: db files netgroup: nis sudoers: files ldap Example: Configuring LDAP with SSL Before configuring LDAP with SSL, make sure to copy your LDAP server's certificate to the switch. The 'tls_cacertfile' option in the nslcd config should point to wherever the certificate is located on the switch. # /etc/nslcd.conf # nslcd configuration file. See nslcd.conf(5) # for details. # The user and group nslcd should run as. uid nslcd gid nslcd # The location at which the LDAP server(s) should be reachable. uri ldaps:// :636 # The search base that will be used for all queries. base dc=qa,dc=plexxi,dc=com # The LDAP protocol version to use. #ldap_version 3 # The DN to bind with for normal lookups. #binddn cn=annonymous,dc=example,dc=net #bindpw secret # The DN used for password modifications by root. #rootpwmoddn cn=admin,dc=example,dc=com # SSL options ssl on tls_reqcert demand tls_cacertfile /etc/ldap/slapd.crt # The search scope. #scope sub Plexxi Switch Administrator Guide using Linux and Plexxi CLI,

33 Example: Configuring LDAP with TLS Similar to the SSL configuration, before configuring LDAP with TLS make sure to copy your LDAP server's certificate to the switch. The 'tls_cacertfile' option in the nslcd config should point to wherever the certificate is located on the switch. # /etc/nslcd.conf # nslcd configuration file. See nslcd.conf(5) # for details. # The user and group nslcd should run as. uid nslcd gid nslcd # The location at which the LDAP server(s) should be reachable. uri ldap:// :389 # The search base that will be used for all queries. base dc=qa,dc=plexxi,dc=com # The LDAP protocol version to use. #ldap_version 3 # The DN to bind with for normal lookups. #binddn cn=annonymous,dc=example,dc=net #bindpw secret # The DN used for password modifications by root. #rootpwmoddn cn=admin,dc=example,dc=com # SSL options ssl start_tls tls_reqcert demand tls_cacertfile /etc/ldap/slapd.crt # The search scope. #scope sub Plexxi Switch Administrator Guide using Linux and Plexxi CLI,

34 Enabling the Authentication Method for a Switch To enable the authentication method for a switch: Note: You must be logged in as administrator user. 1. Using sudo, enter the following command to run the interactive PAM (Pluggable Authentication Modules) configuration tool: sudo pam-auth-update 2. In the PAM configuration window, select the authentication method, then click OK. For example, to enable LDAP authentication: 3. Restart the nscd and nslcd services on the switch to finish applying the configuration. For example: sudo service nscd restart sudo service nslcd restart Plexxi Switch Administrator Guide using Linux and Plexxi CLI,