blob: a6989d2e010ca3459eece23bf5f15de817f1caac [file] [log] [blame]
samanwita palf28207b2015-09-04 10:41:56 -07001/*
Brian O'Connora09fe5b2017-08-03 21:12:30 -07002 * Copyright 2015-present Open Networking Foundation
samanwita palf28207b2015-09-04 10:41:56 -07003 *
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 */
16package org.onosproject.dhcp.cli;
17
Ray Milkey86ad7bb2018-09-27 12:32:28 -070018import org.apache.karaf.shell.api.action.Argument;
19import org.apache.karaf.shell.api.action.Command;
Ray Milkeyb3a5b8d2018-10-03 11:16:11 -070020import org.apache.karaf.shell.api.action.Completion;
Ray Milkey7a2dee52018-09-28 10:58:28 -070021import org.apache.karaf.shell.api.action.lifecycle.Service;
samanwita palf28207b2015-09-04 10:41:56 -070022import org.onlab.packet.MacAddress;
23import org.onosproject.cli.AbstractShellCommand;
Thomas Vachuskaa1da42e2015-09-09 00:45:22 -070024import org.onosproject.dhcp.DhcpService;
samanwita palf28207b2015-09-04 10:41:56 -070025
26/**
27 * Removes a static MAC Address to IP Mapping from the DHCP Server.
28 */
Ray Milkey7a2dee52018-09-28 10:58:28 -070029@Service
samanwita palf28207b2015-09-04 10:41:56 -070030@Command(scope = "onos", name = "dhcp-remove-static-mapping",
31 description = "Removes a static MAC Address to IP Mapping from the DHCP Server")
Thomas Vachuskaa1da42e2015-09-09 00:45:22 -070032public class DhcpRemoveStaticMapping extends AbstractShellCommand {
samanwita palf28207b2015-09-04 10:41:56 -070033
34 @Argument(index = 0, name = "macAddr",
35 description = "MAC Address of the client",
36 required = true, multiValued = false)
Ray Milkeyb3a5b8d2018-10-03 11:16:11 -070037 @Completion(MacIdCompleter.class)
samanwita palf28207b2015-09-04 10:41:56 -070038 String macAddr = null;
39
40 private static final String DHCP_SUCCESS = "Static Mapping Successfully Removed.";
41 private static final String DHCP_FAILURE = "Static Mapping Removal Failed. " +
42 "Either the mapping does not exist or it is not static.";
43
44 @Override
Ray Milkey86ad7bb2018-09-27 12:32:28 -070045 protected void doExecute() {
Thomas Vachuskaa1da42e2015-09-09 00:45:22 -070046 DhcpService dhcpService = AbstractShellCommand.get(DhcpService.class);
samanwita palf28207b2015-09-04 10:41:56 -070047
48 try {
49 MacAddress macID = MacAddress.valueOf(macAddr);
50 if (dhcpService.removeStaticMapping(macID)) {
51 print(DHCP_SUCCESS);
52 } else {
53 print(DHCP_FAILURE);
54 }
55
56 } catch (IllegalArgumentException e) {
57 print(e.getMessage());
58 }
59 }
60}