Brian Stanke | 5df1447 | 2016-03-11 19:34:38 -0500 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Foundation |
Brian Stanke | 5df1447 | 2016-03-11 19:34:38 -0500 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package org.onosproject.cli.net.vnet; |
| 18 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 19 | import org.apache.karaf.shell.api.action.Argument; |
| 20 | import org.apache.karaf.shell.api.action.Command; |
Ray Milkey | 0068fd0 | 2018-10-11 15:45:39 -0700 | [diff] [blame] | 21 | import org.apache.karaf.shell.api.action.Completion; |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 22 | import org.apache.karaf.shell.api.action.lifecycle.Service; |
Brian Stanke | 5df1447 | 2016-03-11 19:34:38 -0500 | [diff] [blame] | 23 | import org.onosproject.cli.AbstractShellCommand; |
| 24 | import org.onosproject.incubator.net.virtual.NetworkId; |
| 25 | import org.onosproject.incubator.net.virtual.VirtualNetworkService; |
| 26 | import org.onosproject.incubator.net.virtual.VirtualPort; |
| 27 | import org.onosproject.net.DeviceId; |
| 28 | import org.onosproject.utils.Comparators; |
| 29 | |
| 30 | import java.util.ArrayList; |
| 31 | import java.util.Collections; |
| 32 | import java.util.List; |
| 33 | |
| 34 | /** |
| 35 | * Lists all virtual ports for the network ID. |
| 36 | */ |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 37 | @Service |
Brian Stanke | 5df1447 | 2016-03-11 19:34:38 -0500 | [diff] [blame] | 38 | @Command(scope = "onos", name = "vnet-ports", |
| 39 | description = "Lists all virtual ports in a virtual network.") |
| 40 | public class VirtualPortListCommand extends AbstractShellCommand { |
| 41 | |
| 42 | private static final String FMT_VIRTUAL_PORT = |
Claudine Chiu | 579969d | 2017-10-06 14:32:18 -0400 | [diff] [blame] | 43 | "virtual portNumber=%s, physical deviceId=%s, portNumber=%s, isEnabled=%s"; |
Brian Stanke | 5df1447 | 2016-03-11 19:34:38 -0500 | [diff] [blame] | 44 | |
| 45 | @Argument(index = 0, name = "networkId", description = "Network ID", |
| 46 | required = true, multiValued = false) |
Ray Milkey | 0068fd0 | 2018-10-11 15:45:39 -0700 | [diff] [blame] | 47 | @Completion(VirtualNetworkCompleter.class) |
Brian Stanke | 5df1447 | 2016-03-11 19:34:38 -0500 | [diff] [blame] | 48 | Long networkId = null; |
| 49 | |
| 50 | @Argument(index = 1, name = "deviceId", description = "Virtual Device ID", |
| 51 | required = true, multiValued = false) |
Ray Milkey | 0068fd0 | 2018-10-11 15:45:39 -0700 | [diff] [blame] | 52 | @Completion(VirtualDeviceCompleter.class) |
Brian Stanke | 5df1447 | 2016-03-11 19:34:38 -0500 | [diff] [blame] | 53 | String deviceId = null; |
| 54 | |
| 55 | @Override |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 56 | protected void doExecute() { |
Brian Stanke | 5df1447 | 2016-03-11 19:34:38 -0500 | [diff] [blame] | 57 | |
| 58 | getSortedVirtualPorts().forEach(this::printVirtualPort); |
| 59 | } |
| 60 | |
| 61 | /** |
| 62 | * Returns the list of virtual ports sorted using the network identifier. |
| 63 | * |
| 64 | * @return sorted virtual port list |
| 65 | */ |
| 66 | private List<VirtualPort> getSortedVirtualPorts() { |
| 67 | VirtualNetworkService service = get(VirtualNetworkService.class); |
| 68 | |
| 69 | List<VirtualPort> virtualPorts = new ArrayList<>(); |
Yoonseon Han | 6c60389 | 2016-09-01 11:52:21 -0700 | [diff] [blame] | 70 | virtualPorts.addAll(service.getVirtualPorts(NetworkId.networkId(networkId), |
| 71 | DeviceId.deviceId(deviceId))); |
Brian Stanke | 5df1447 | 2016-03-11 19:34:38 -0500 | [diff] [blame] | 72 | Collections.sort(virtualPorts, Comparators.VIRTUAL_PORT_COMPARATOR); |
| 73 | return virtualPorts; |
| 74 | } |
| 75 | |
| 76 | /** |
| 77 | * Prints out each virtual port. |
| 78 | * |
| 79 | * @param virtualPort virtual port |
| 80 | */ |
| 81 | private void printVirtualPort(VirtualPort virtualPort) { |
Yoonseon Han | 6c60389 | 2016-09-01 11:52:21 -0700 | [diff] [blame] | 82 | if (virtualPort.realizedBy() == null) { |
Claudine Chiu | 579969d | 2017-10-06 14:32:18 -0400 | [diff] [blame] | 83 | print(FMT_VIRTUAL_PORT, virtualPort.number(), "None", "None", virtualPort.isEnabled()); |
Yoonseon Han | 6c60389 | 2016-09-01 11:52:21 -0700 | [diff] [blame] | 84 | } else { |
| 85 | print(FMT_VIRTUAL_PORT, virtualPort.number(), |
| 86 | virtualPort.realizedBy().deviceId(), |
Claudine Chiu | 579969d | 2017-10-06 14:32:18 -0400 | [diff] [blame] | 87 | virtualPort.realizedBy().port(), |
| 88 | virtualPort.isEnabled()); |
Yoonseon Han | 6c60389 | 2016-09-01 11:52:21 -0700 | [diff] [blame] | 89 | } |
Brian Stanke | 5df1447 | 2016-03-11 19:34:38 -0500 | [diff] [blame] | 90 | } |
| 91 | } |