snmpit.in 24.4 KB
Newer Older
1 2
#!/usr/bin/perl -w

Leigh Stoller's avatar
Leigh Stoller committed
3 4
#
# EMULAB-COPYRIGHT
5
# Copyright (c) 2000-2003 University of Utah and the Flux Group.
Leigh Stoller's avatar
Leigh Stoller committed
6 7 8 9
# All rights reserved.
#


10 11 12 13 14 15 16 17 18
#
# snmpit - A tool for setting up VLANs on SNMP-controllable switches
#

#
# Configure variables
#

use lib '@prefix@/lib';
19
my $TESTMODE = @TESTMODE@;
20
my $TB = '@prefix@';
21

22 23 24 25
use libdb;
use snmpit_lib;

use English;
26
use Getopt::Long;
27
use strict;
28

29 30 31
#
# Defaults
#
32
my $debug = 0;
33 34 35 36 37 38 39 40 41 42

######################################################################
# Step 1 - Process command-line arguments
#
# We have a fairly complex set of command line arguments, and we
# need to make sure that the user only specifies one command at a
# time.
######################################################################
sub usage {
    print << "END";
Robert Ricci's avatar
Robert Ricci committed
43
Usage: $0 [-h] [-v] [-n] [-i device]
44 45 46 47 48
	  [-l] [-s] [-g]
	  [-m name [ports]]
	  [-o name]
          [-r pid eid]
	  [-t pid eid]
49 50
	  [-d ports] [-e ports] [-a ports]
	  [-p <10|100> ports] [-u <half|full> ports]
51
	  [-c]
52 53 54
General:
  -h          Display this help message
  -v          Verbose mode
Robert Ricci's avatar
Robert Ricci committed
55
  -n          Test mode - don't actually make any changes
56 57
  -i <device> Operate on <device>, overriding default device list. Can be
                  given multiple times
58 59 60 61 62

VLAN Control:
  -t <pid> <eid>    Create all VLANs from database tables for an experiment
  -r <pid> <eid>    Remove all VLANs from database tables for an experiment
  -l                List all VLANs
63
  -w                Used with -l, includes device-specific VLAN number
64
  -M                Used with -l, print MAC addresses instead of port numbers
65 66
  -m <name> [ports] Create a new VLAN with name <name>, if it doesn't exist,
                        and put [ports] in it
Robert Ricci's avatar
Robert Ricci committed
67 68 69 70 71 72
  -y <type>         When used with -m, the new VLAN becomes a private VLAN
                        of type <type>
  -x <primary>      When used with -y, assocates the new private VLAN with
                        the primary VLAN named <primary>
  -z <port>         Used with -y and -x, to specify which port is to be used
                        with the private VLAN
73
  -o <name>         Delete the VLAN with name <name>
74 75
  -c                Delete ALL VLANs, and recreate from the database. ** USE
                        WITH EXTREME CAUTION **
76 77

Port Control:
78 79 80 81 82 83 84 85 86 87 88
  -s                     List all ports, and show configuration information
  -g                     Get port statistics
  -d <ports>             Disable <ports>
  -e <ports>             Enable <ports>
  -a <ports>             Enable auto-negotiation of port speed/duplex
  -p <10|100> <ports>    Set speed of <ports> to 10 or 100 Mbps
  -u <half|full> <ports> Set duplex of <ports> to half or full

More than one operation can be specified - However, beware that the order in
which operations will occur is undefined, and some combinations of operations
(ie. -d and -e) are non-sensical.
89 90 91
END

    return 1;
92 93
}

94

95
my %opt = ();
96
Getopt::Long::Configure("no_ignore_case");
97 98 99
GetOptions(\%opt, 'a','c','d','e','g','h','i=s@','l','m=s@','M','n','o=s@',
    'p=s','r','s','t','u=s','v','w','y=s','x=s','z=s');
# Unused: b,f,j,q
100 101 102 103

if ($opt{h}) {
    exit &usage;
}
104

105 106 107 108 109 110 111 112
if ($opt{v}) {
    $debug = $opt{v};
    print "Debug level is $debug\n";
}

#
# Values that may have been passed on the command line
#
113 114
my $pid;
my $eid;
115 116 117 118 119 120 121 122 123 124
my @ports;

#
# Some operations have mandatory agruments - for others, make sure that
# the user didn't give any extraneous arguments
#
if ($opt{t} || $opt{r}) {
    #
    # Options that take 'pid eid'
    #
125
    if (@ARGV < 2) {
126 127
	warn "ERROR: pid/eid reqired!\n";
	exit &usage;
128
    } else {
129
	($pid, $eid) = (shift @ARGV, shift @ARGV);
130
    }
131 132 133 134 135 136 137 138 139 140 141 142
} elsif ($opt{d} || $opt{e} || $opt{a} || $opt{p} || $opt{u} || $opt{m}) {
    #
    # Options that take a list of ports
    #
    @ports = @ARGV;
} else {
    #
    # Everything else
    #
    if (@ARGV) {
	warn "ERROR: Too many arguments!\n";
	exit &usage;
143
    }
144 145 146 147 148 149 150
}

#
# Determine which operation we're performing. This is just for convenience,
# so that we can use switch-like constructs later. While we're at it, we
# pull out any arguments that were given in the $opt{} values.
#
151 152 153 154 155 156 157 158 159 160
my @commands;

#
# Simple commands
#
if ($opt{l}) { push @commands, ["listvlans"]; }
if ($opt{s}) { push @commands, ["listports"]; }
if ($opt{g}) { push @commands, ["getstats"]; }
if ($opt{t}) { push @commands, ["tables"]; }
if ($opt{r}) { push @commands, ["reset"]; }
161
if ($opt{c}) { push @commands, ["recreate"]; }
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188

#
# Commands that can appear once, and take an agurment
#
if ($opt{d}) { push @commands, ["portcontrol","disable"]; }
if ($opt{e}) { push @commands, ["portcontrol","enable"]; }
if ($opt{a}) { push @commands, ["portcontrol","auto"]; }

#
# Commands that can occur more than once
#
if ($opt{m}) {
    foreach my $name (@{$opt{m}}) {
	push @commands, ["make",$name];
    }
}

if ($opt{o}) {
    foreach my $name (@{$opt{o}}) {
	push @commands, ["remove",$name];
    }
}

#
# Commands that require 'translation' of their arguments
#
if ($opt{p}) {
189 190 191 192
    #
    # We'll put the argument in the form needed by the portControl function
    #
    if ($opt{p} =~ /^100/) {
193
	push @commands, ["portcontrol","100mbit"];
194
    } elsif ($opt{p} =~ /^10/) {
195
	push @commands, ["portcontrol","10mbit"];
196 197
    } else {
	die "Bad port speed: $opt{p}. Valid values are 10 and 100\n";
198
    }
199 200
}
if ($opt{u}) {
201 202 203 204
    #
    # We'll put the argument in the form needed by the portControl function
    #
    if ($opt{u} =~ /half/) {
205
	push @commands, ["portcontrol","half"];
206
    } elsif ($opt{u} =~ /full/) {
207
	push @commands, ["portcontrol","full"];
208 209
    } else {
	die "Bad port duplex: $opt{u}. Valid values are full and half\n";
210
    }
211 212 213
}

if (!@commands) {
214 215
    die "No operation given\n";
}
216

Robert Ricci's avatar
Robert Ricci committed
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
#
# Options that affect other commands
#

#
# Arguments for making private VLANs
#
# Build up a list of extra arguments to be passed to createVlan()
my @pvlanArgs = ();
if ($opt{y}) {
    #
    # Make sure the private VLAN type they gave is valid, and make sure they
    # gave the other required arugments for certain types
    #
    if ($opt{y} ne "primary" && $opt{y} ne "isolated" &&
	$opt{y} ne "community") {
	die "Unknown private VLAN type $opt{y}\n";
    }
    @pvlanArgs = $opt{y};
    if ($opt{y} ne "primary") {
	if (!$opt{x} || !$opt{z}) {
	    warn "**** -x and -z must be given when -y is $opt{y}!\n";
	    exit &usage;
	}
	#
	# Fix up ports given in the module/port format, like we do below for
	# ports from @ARGV
	#
	if ($opt{z} =~ /^\d+\/\d+?$/) {
	    if ($opt{i} && @{$opt{i}} == 1) {
		$opt{z} = $opt{i}->[0] . "." . $opt{z};
	    } else {
		die "The module/port format is only legal if exactly one -i " .
		    "argument has been given\n";
	    }
	}
	push @pvlanArgs,$opt{x},$opt{z};
    }
}
256 257 258 259 260 261 262 263 264 265 266 267 268

######################################################################
# Step 3 - Set up the stack objects
#
# Determine which devices to talk to, and make the appropriate
# stack objects
######################################################################

#
# If this is an operation on an experiment, make sure that they have permission
# to modify that experiment
#
if ($pid && $eid) {
Robert Ricci's avatar
Robert Ricci committed
269 270 271 272 273 274
    #
    # First, make sure the experiment exists
    #
    if (!ExpState($pid,$eid)) {
	die "There is no experiment $eid in project $pid\n";
    }
275 276
    if (!TBExptAccessCheck($UID,$pid,$eid,TB_EXPT_MODIFY)) {
	die "You do not have permission to modify experiment $pid/$eid\n";
277
    }
278 279 280 281 282 283
}

#
# If their operation involves a set of ports, make sure that the caller has
# access to the nodes that the ports are on
#
284

285
if (@ports) {
Robert Ricci's avatar
Robert Ricci committed
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
    #
    # Allow ports to be given in one of two forms: node:port, or switch.port.
    # Only admins can do the latter, of course...
    #
    my (@nodes, @switchports);
    foreach my $port (@ports) {
	if ($port =~ /^([^:]+):\d+$/) {
	    push @nodes, $1;
	} elsif ($port =~ /^([^.]+)\.\d+(\/\d+)?$/) {
	    push @switchports, $port;
	} elsif ($port =~ /^\d+\/\d+?$/) {
	    if ($opt{i} && @{$opt{i}} == 1) {
		$port = $opt{i}->[0] . "." . $port;
		push @switchports, $port;
	    } else {
		die "The module/port format is only legal if exactly one -i " .
		    "argument has been given\n";
	    }
	} else {
	    die "Bad format for port $port\n"
	}
    }

309 310 311
    if (!TBNodeAccessCheck($UID,TB_NODEACCESS_MODIFYVLANS,@nodes)) {
	die "You do not have permission to modify some or all of the nodes\n" .
		"that will be affected by the operation you requested\n";
312
    }
Robert Ricci's avatar
Robert Ricci committed
313 314 315 316

    if (@switchports && !TBAdmin()) {
	die "Only admins are allowed to modify switch ports directly\n";
    }
317
}
318

319 320 321
if ($TESTMODE) {
    print "Test mode, exiting without touching hardware\n";
    exit(0);
322 323
}

324
#
325 326
# snmpit_lib fills out some hashes for speed of lookup later. Initialize
# them now
327
#
328 329
snmpit_lib::init($debug);

Robert Ricci's avatar
Robert Ricci committed
330
my $exitval = 0;
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
foreach my $command (@commands) {

    #
    # Pull the operation and the arugments to it.
    #
    my ($operation,@args) = @$command;

    debug("Operation is $operation\n");

    #
    # Discover the set of devices we need to talk to. This differs depending
    # on the operation which we're performing. We also get a list of all ports
    # and vlan IDs involved in this operation, if appropriate
    #
    my @devicenames;
    my @vlans;
    SWITCH: for ($operation) {
348
	(/listvlans/ || /getstats/ || /make/ || /remove/) && do {
349
	    @devicenames = $opt{i}? @{$opt{i}} : getTestSwitches();
350
	    last;
351
	};
352
	(/listports/) && do {
353 354
	    @devicenames = $opt{i}? @{$opt{i}} :
	    (@ports? getDeviceNames(@ports) : getTestSwitches());
355 356
	    last;
	};
357 358 359
	(/tables/) && do {
	    @vlans = getExperimentVlans($pid,$eid);
	    @ports = getVlanPorts(@vlans);
360
	    @devicenames = $opt{i}? @{$opt{i}} : getTestSwitches();
361 362 363 364 365 366 367 368 369 370 371 372 373 374
	    last;
	};
	(/reset/) && do {
	    #
	    # When we reset, we operate on all test switches, just to be safe
	    #
	    @vlans = getExperimentVlans($pid,$eid);
	    @devicenames = $opt{i}? @{$opt{i}} : getTestSwitches();
	    last;
	};
	(/portcontrol/) && do {
	    @devicenames = $opt{i}? @{$opt{i}} : getDeviceNames(@ports);
	    last;
	};
375 376 377 378 379 380 381 382 383 384 385
	(/recreate/) && do {
	    #
	    # Safety check - cannot be used with -i . We have to operate on
	    # all experimental switches
	    #
	    if ($opt{i}) {
		die "-c and -i cannot be used together\n";
	    }
	    @devicenames = getTestSwitches();
	    last;
	};
386
    }
387

388 389 390 391 392 393 394 395 396 397 398 399
    debug("Device names: " . join(",",@devicenames) . "\n");
    debug("Ports: " . join(",",@ports) . "\n");

    #
    # Find out which stack each device belongs to
    #
    my %stacks = ();
    foreach my $devicename (@devicenames) {
	my $stack = getSwitchStack($devicename);
	if (defined($stack)) {
	    push @{$stacks{$stack}}, $devicename;
	}
400
    }
401 402

    #
403
    # Now, make the object for each stack that we discovered
404
    #
405 406
    my @stacks;
    foreach my $stack_id (keys %stacks) {
407
	my ($stack_type, $supports_private, $single_domain, $community)
408
		= getStackType($stack_id);
Robert Ricci's avatar
Robert Ricci committed
409 410 411 412 413 414 415
	#
	# Safety check - make sure the stack supports private VLANs if -y was
	# given
	#
	if ($opt{y} && !$supports_private) {
	    die "Switch stack $stack_id does not support private VLANs\n";
	}
416

417 418 419
	my $stack;
	debug("Stack $stack_id has type $stack_type\n");
	SWITCH: for ($stack_type) {
420
	    (/cisco/ || /catalyst/) && do {
421
		require snmpit_cisco_stack;
422 423
		$stack = new snmpit_cisco_stack($stack_id,$debug,$single_domain,
		    @{$stacks{$stack_id}});
424 425 426 427
		last;
	    }; # /cisco/
	    /intel/ && do {
		require snmpit_intel_stack;
428
		$stack = new snmpit_intel_stack($stack_id,$debug,
429
		    @{$stacks{$stack_id}});
430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
		last;
	    };

	    # 'default' case
	    die "Unknown stack type $stack_type for stack $stack_id\n";
	}

	#
	# Check for error in object creation and bail
	#
	if (!$stack) {
	    die "Unable to connect to one or more switches, exiting\n";
	} else {
	    push @stacks, $stack;
	}
445
    }
446

447
######################################################################
448
# Step 4 - Actually perfrom the operation
449 450
#
# Finally, we just call the helper function for the operation that
451
# is to be performed.
452
######################################################################
Robert Ricci's avatar
Robert Ricci committed
453 454 455 456
    if ($opt{n}) {
	print "Test mode, skipping operation\n";
	next;
    }
457

458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
    SWITCH: for ($operation) {
	/listvlans/ && do {
	    $exitval += doListVlans(\@stacks);
	    last;
	}; # /listvlans/ && do 
	/listports/ && do {
	    $exitval += doListPorts(\@stacks);
	    last;
	}; # /listports/ && do
	/getstats/ && do {
	    $exitval += doGetStats(\@stacks);
	    last;
	}; # /ports/ && do
	/tables/ && do {
	    $exitval += doVlansFromTables(\@stacks,@vlans);
	    last;
	}; # /tables/ && do
	/reset/ && do {
	    $exitval += doReset(\@stacks,@vlans);
	    last;
	};
	/make/ && do {
	    my ($vlan_name) = @args;
	    $exitval += doMakeVlan(\@stacks,$vlan_name,@ports);
	    last;
	};
	/remove/ && do {
	    my ($vlan_name) = @args;
	    $exitval += doDeleteVlan(\@stacks,$vlan_name);
	    last;
	};
	/portcontrol/ && do {
490
	    my ($portcommand) = @args;
491
	    $exitval += doPortControl(\@stacks,$portcommand,@ports);
492 493 494 495 496
	    last;
	};
	/recreate/ && do {
	    $exitval += doRecreateVlans(\@stacks);
	    last;
497 498
	};
    }
499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518
}

exit $exitval;

######################################################################
# Subs
######################################################################

#
# Print given message to STDERR, only if debug mode is on
#
sub debug($) {
    if ($debug) {
	print STDERR @_;
    }
}

#
# Lists all vlans on all stacks
#
519 520 521
sub doListVlans ($) {

    my $stacks = shift;
522 523 524 525 526 527 528
    
    my %vlans;

    #
    # We need to 'coallate' the results from each stack by putting together
    # the results from each stack, based on the VLAN identifier
    #
529
    foreach my $stack (@$stacks) {
530 531 532
	my @vlanList = $stack->listVlans();
	foreach my $vlan (@vlanList) {
	    my ($id,$ddep,$memberref) = @$vlan;
533
	    ${$vlans{$id}}[0] = $ddep;
534 535 536 537 538 539 540 541
	    push @{${$vlans{$id}}[1]}, @$memberref;
	}
    }

    #
    # These need to be declared here for the benefit of the format string
    # See perlform(1) for help with formats
    #
542 543 544 545 546 547 548
    my ($vlan_id,$ddep,$pideid,$vname,$members);
    #
    # Check to see if they want device-specific VLAN numbers, which makes the
    # display more cramped, but is useful for debugging
    #
    if (!$opt{w}) { 
	print << "END";
549
VLAN     Project/Experiment VName     Members
550 551
--------------------------------------------------------------------------------
END
552
	format vlanlist =
553 554
@<<<<<<< @<<<<<<<<<<<<<<<<< @<<<<<<<< ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
$vlan_id,$pideid,           $vname,   $members
555 556 557
~~                                    ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
                                      $members
.
558 559 560 561 562 563 564 565 566 567 568 569 570 571
	$FORMAT_NAME = 'vlanlist';
    } else {
    	print << "END";
VLAN     Number Project/Experiment VName     Members
--------------------------------------------------------------------------------
END
	format vlanlist2 =
@<<<<<<< @<<<<< @<<<<<<<<<<<<<<<<< @<<<<<<<< ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
$vlan_id,$ddep, $pideid,           $vname,   $members
~~                                           ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
                                             $members
.
	$FORMAT_NAME = 'vlanlist2';
}
572 573

    foreach $vlan_id (sort {tbsort($a,$b)} keys %vlans) {
574 575
	my $memberref;
	($ddep,$memberref) = @{$vlans{$vlan_id}};
576 577 578 579 580 581 582

	#
	# Find which, if any, experiment this VLAN belongs to.
	#
	my $result = DBQueryFatal("select pid, eid, virtual from " .
				  "vlans where id='$vlan_id'");
	my ($eid,$pid);
583 584 585
	($pid,$eid,$vname) = $result->fetchrow();

	#
586
	# Permissions check - people only get to see their own VLANs
587 588 589 590 591 592 593 594 595 596 597
	#
	if ((!$eid) || (!$pid)) {
	    if (!TBAdmin()) {
		&debug("Failed TBAdmin check\n");
		next;
	    }
	} elsif (!TBExptAccessCheck($UID,$pid,$eid,TB_EXPT_READINFO)) {
	    &debug("Failed TBExptAccessCheck($UID,$pid,$eid)\n");
	    next;
	}

598 599

	if (!$vname) { $vname = ""; }
600 601 602 603 604 605 606 607 608 609 610 611 612

	#
	# Check to see if we were supposed to print out MAC addresses
	#
	if ($opt{M}) {
	    # Rather than node:port, print out node:MAC (if we know the MAC)
	    $members = join(" ", map
		{
		    macport($_)? (split /:/)[0] . ":" . macport($_) : $_
		} @$memberref);
	} else {
	    $members = join(" ",@$memberref);
	}
613 614 615 616 617

	#
	# Setup $pideid for a more compact display
	#
	if ($eid && $pid) {
618
	    $pideid = "$pid/$eid";
619
	} else {
620
	    $pideid = "";
621
	}
622
	write;
623
    }
624 625 626 627 628 629 630

    return 0;
}

#
# Lists all ports on all stacks
#
631 632 633
sub doListPorts($) {

    my $stacks = shift;
634 635 636 637 638

    #
    # Get a listing from all stacks
    #
    my @portList = ();
639
    foreach my $stack (@$stacks) {
640
	push @portList, $stack->listPorts;
641
    }
642 643 644 645 646 647 648

    #
    # See perlform(1) for help with formats
    #
    my ($port,$enabled,$up,$speed,$duplex);
    print << "END";
Port      Enabled Up   Speed      Duplex
649
--------------------------------------------
650 651
END
    format portlist =
652
@<<<<<<<< @<<<<<< @<<< @<<<<<<<<< @<<<<<<<<<
653 654 655 656 657
$port,    $enabled,$up,$speed,$duplex
.
    $FORMAT_NAME = 'portlist';
    foreach my $line (sort {tbsort($$a[0],$$b[0])} @portList) {
	($port,$enabled,$up,$speed,$duplex) = @$line;
658 659 660 661 662 663 664 665 666 667 668 669 670 671
	#
	# Only let people see information about ports in their experiments
	#
	$port =~ /^(.+):/;
	my $node = $1;

	&debug("node is $node\n");
	if (!$node) {
	    if (!TBAdmin($UID)) {
		next;
	    }
	} elsif (!TBNodeAccessCheck($UID,TB_NODEACCESS_READINFO,$node)) {
	    next;
	}
672
	write;
673
    }
674 675 676 677 678 679 680

    return 0;
}

#
# Get statistics for all ports on all stacks
#
681 682 683
sub doGetStats($) {

    my $stacks = shift;
684 685 686 687 688

    #
    # Get a listing from all stacks
    #
    my @statList = ();
689
    foreach my $stack (@$stacks) {
690
	push @statList, $stack->getStats();
691
    }
692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717

    my ($port, $inoctets, $inunicast, $innunicast, $indiscards, $inerr,
        $inunk, $outoctets, $outunicast, $outnunicast, $outdiscards,
	$outerr,$outq);
    #
    # See perlform(1) for help with formats
    #
    print << "END";
          In         InUnicast  InNUnicast In         In         Unknown    Out        OutUnicast OutNUcast  Out       Out         OutQueue
Port      Octets     Packets    Packets    Discards   Errors     Protocol   Octets     Packets    Packets    Discards  Errors      Length
---------------------------------------------------------------------------------------------------------------------------------------------
END
    format stats =
@<<<<<<<< @>>>>>>>>> @>>>>>>>>> @>>>>>>>>> @>>>>>>>>> @>>>>>>>>> @>>>>>>>>> @>>>>>>>>> @>>>>>>>>> @>>>>>>>>> @>>>>>>>>> @>>>>>>>>> @>>>>>>>>> 
$port,    $inoctets, $inunicast,$innunicast,$indiscards,$inerr,  $inunk,    $outoctets,$outunicast,$outnunicast,$outdiscards,$outerr,$outq
.
    $FORMAT_NAME = 'stats';
    foreach my $line (sort {tbsort($a,$b)} @statList) {
	($port, $inoctets, $inunicast, $innunicast, $indiscards, $inerr,
	 $inunk, $outoctets, $outunicast, $outnunicast, $outdiscards,
	 $outerr, $outq) = @$line;
	write;
    }

    return 0;
}
718

719 720 721 722
#
# Creates all VLANs given. Looks up identifiers in the database to determine
# the membership.
#
723 724
sub doVlansFromTables($@) {
    my $stacks = shift;
725 726 727 728
    my @vlans = @_;

    my $errors = 0;

729
    if (@$stacks > 1) {
730
	die "VLAN creation accross multiple stacks is not yet supported\n" .
731
	    "Stacks are " . join(",",@$stacks) . "\n";
732
    }
733
    my ($stack) = @$stacks;
734 735

    foreach my $vlan (@vlans) {
Robert Ricci's avatar
Robert Ricci committed
736 737 738
	my @ports = getVlanPorts($vlan);
	if ($stack->vlanExists($vlan)) {
	    print "  VLAN $vlan already exists\n";
739
	    $errors += $stack->setPortVlan($vlan,@ports);
Robert Ricci's avatar
Robert Ricci committed
740
	} else {
Robert Ricci's avatar
Robert Ricci committed
741
	    if (!$stack->createVlan($vlan,\@ports)) {
Robert Ricci's avatar
Robert Ricci committed
742 743 744 745 746
		warn "ERROR: Failed to create VLAN with id $vlan\n";
		#
		# Don't try to put ports in a VLAN if it couldn't be created
		#
		$errors++;
747 748
	    }
	}
749

750 751 752 753 754 755 756 757 758 759
	#
	# Set the speed and duplex of each interface depending on the
	# value in the database
	#
	foreach my $port (@ports) {
	    my ($speed,$duplex) = getInterfaceSettings($port);
	    #
	    # If either is not set, we do nothing. We could make
	    # a 0 mean 'auto'
	    #
760
	    # For now, we ignore it if the switch doesn't support the commands.
761 762
	    if ($speed) {
		my $cmd = $speed . "mbit";
763 764 765 766 767
		my $rv = $stack->portControl($cmd, $port);
		if ($rv > 0) {
		    $errors += $rv;
		}

768 769
	    }
	    if ($duplex) {
770 771 772 773
		my $rv = $stack->portControl($duplex, $port);
		if ($rv > 0) {
		    $errors += $rv;
		}
Robert Ricci's avatar
Robert Ricci committed
774
	    }
775 776
	}
    }
777 778 779 780 781 782 783 784 785

    return $errors;
}

#
# Remove all VLANs given from every switch in the stack. All ports in the
# VLANs are removed, irrespective of what the database says membership should
# be
#
786 787
sub doReset($@) {
    my $stacks = shift;
788 789 790
    my @vlans = @_;

    my $errors = 0;
791 792 793 794 795
    #
    # Just remove the VLAN from evey satck on which it exists. We keep a
    # list and do them all at once for efficiency.
    #
    foreach my $stack (@$stacks) {
796
	my @existant_vlans = $stack->existantVlans(@vlans);
797 798 799
	if (!$stack->removeVlan(@existant_vlans)) {
	    $errors++;
	}
800
    }
801 802 803 804 805 806 807 808
    return $errors;
}

#
# Create a vlan with name $vlan_name. It is not an error to try to create a
# VLAN that already exists, as this can be used to add ports to an existing
# VLAN. If ports are given, they are put into the VLAN.
#
809 810
sub doMakeVlan($$@) {
    my $stacks = shift;
811 812 813
    my $vlan_name = shift;
    my @ports = @_;

814
    my $errors = 0;
815

816
    if (@$stacks > 1) {
817
	die "VLAN creation accross multiple stacks is not yet supported\n" .
818
	    "Stacks are " . join(",",@$stacks) . "\n";
819
    }
820
    my ($stack) = @$stacks;
821 822 823 824 825 826

    #
    # Create it if it doesn't already exist
    #
    if ($stack->vlanExists($vlan_name)) {
	print "VLAN $vlan_name already exists\n";
827 828 829 830 831 832 833 834 835 836 837
	#
	# Put requested ports into the VLAN
	#
	if (@ports) {
	    print "Putting ports in VLAN ...\n";
	    my $perrors = $stack->setPortVlan($vlan_name,@ports);
	    print "VLAN change ";
	    print $perrors? "failed":"succeeded",".\n";
	    $errors += $perrors;

	}
838
    } else {
839
	print "Creating VLAN $vlan_name ...\n";
Robert Ricci's avatar
Robert Ricci committed
840
	my $ok = $stack->createVlan($vlan_name,\@ports,@pvlanArgs);
841 842 843 844 845
	print "VLAN creation ";
	print $ok? "succeeded":"failed",".\n";
	if (!$ok) {
	    $errors++;
	}
846
    }
847 848

    return $errors;
849 850
}

851 852 853
#
# Delete the given VLAN, if it exists
#
Robert Ricci's avatar
Robert Ricci committed
854
sub doDeleteVlan($@) {
855
    my $stacks = shift;
Robert Ricci's avatar
Robert Ricci committed
856
    my @vlan_names = @_;
857 858 859

    my $errors = 0;

Robert Ricci's avatar
Robert Ricci committed
860
    my %exists = ();
861
    foreach my $stack (@$stacks) {
Robert Ricci's avatar
Robert Ricci committed
862 863 864 865 866 867 868 869 870 871
	my @existant_vlans;
	foreach my $vlan_name (@vlan_names) {
	    if ($stack->vlanExists($vlan_name)) {
		$exists{$vlan_name} = 1;
		push @existant_vlans, $vlan_name;
	    }
	}
	if (@existant_vlans) {
	    print "Deleting VLAN(s) " . join(",",@existant_vlans) . " ...\n";
	    my $ok = $stack->removeVlan(@existant_vlans);
872
	    print "VLAN deletion ";
873 874 875 876
	    print $ok? "succeeded":"failed",".\n";
	    if (!$ok) {
		$errors++;
	    }
877
	}
878
    }
879

Robert Ricci's avatar
Robert Ricci committed
880 881 882 883 884
    foreach my $vlan_name (@vlan_names) {
	if (!$exists{$vlan_name}) {
	    print "VLAN $vlan_name does not exist\n";
	    $errors++;
	}
885
    }
886 887

    return $errors;
888
}
889 890 891 892 893

#
# Send $command to @ports.
# TODO: List of commands
#
894 895
sub doPortControl($$@) {
    my $stacks = shift;
896 897 898
    my $command = shift;
    my @ports = @_;

899
    if (@$stacks > 1) {
900
	die "Port control accross multiple stacks is not yet supported\n" .
901
	    "Stacks are " . join(",",@$stacks) . "\n";
902
    }
903
    my ($stack) = @$stacks;
904 905 906 907 908 909 910 911 912 913

    print "Applying command '$command' to ports " . join(",",@ports) . " ...\n";
    my $errors = $stack->portControl($command,@ports);
    print "Port command ";
    print $errors? "failed":"succeeded",".\n";

    return $errors;

}

914 915 916 917 918 919 920 921 922 923 924 925
#
# Remove all VLANs from the switch, and re-create them from the database
# tables.
#
sub doRecreateVlans($) {
    my $stacks = shift;

    #
    # Make sure the user REALLY wants to do this
    #

    if (!TBAdmin()) {
926
	warn "Sorry, only admins get to use this function\n";
927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953
	return 0;
    }

    warn "WARNING: Using this function will cause all VLANS to be\n";
    warn "deleted and re-created. This will cause temporary disruption,\n";
    warn "and you will lose all hand-created VLANs. This function operates\n";
    warn "on ALL experimental switches.\n";
    warn "\nAre you SURE you want to do this? (yes/no)\n";

    my $doit = <>;

    if (!($doit =~ /^y/i)) {
	warn "Not recreating VLANs\n";
	return 0;
    } else {
	warn "Okay, recreating VLANs\n";
    }

    #
    # Get a list of all VLANs on all of the given switches, so that we can
    # nuke them.
    #
    my @vlansToNuke = ();
    foreach my $stack (@$stacks) {
	my @stackVlans = $stack->listVlans();
	foreach my $vlan (@stackVlans) {
	    my $id = $$vlan[0];
954 955 956 957 958 959 960
	    #
	    # Special case - don't try to delete the 'switch-control' VLAN,
	    # because that's the one we're talking to the switches on.
	    #
	    if ($id ne 'switch-control') {
		push (@vlansToNuke,$id);
	    }
961 962 963 964 965
	}
    }

    debug("Going to nuke " . join(',',@vlansToNuke) . "\n");

Robert Ricci's avatar
Robert Ricci committed
966
    doDeleteVlan($stacks,@vlansToNuke);
967 968 969 970 971 972 973 974 975 976 977 978 979 980 981

    #
    # Get a list of all experiments, so that we can re-create their VLANs
    #
    my @expts = ();
    my $result = DBQueryFatal("select pid,eid from experiments ".
    	"where state = '". EXPTSTATE_ACTIVE. "'");
    while (my ($pid,$eid) = $result->fetchrow()) {
	my @vlans = getExperimentVlans($pid,$eid);
	doVlansFromTables($stacks,@vlans);
    }

    return 1;

}