Skip to content

Commit 4cf8d36

Browse files
benoit-nexthopmeta-codesync[bot]
benoit-nexthop
authored and
meta-codesync[bot]
committed
Add a "fboss2 config interface <name> description <desc>" command. (#760)
Summary: **Pre-submission checklist** - [x] I've ran the linters locally and fixed lint errors related to the files I modified in this PR. You can install the linters by running `pip install -r requirements-dev.txt && pre-commit install` - [x] `pre-commit run` Add some helper code to process interface-list arguments. Note: this change is part of a series, the previous one is #759, the next one is #761. Pull Request resolved: #760 Test Plan: Unit tests. New end to end tests for this command are in #783. ## Sample usage ``` [admin@fboss101 benoit]$ ./fboss2-dev show interface | head +-----------+--------+-------+------+------+------------------------------+----------------------------+ | Interface | Status | Speed | VLAN | MTU | Addresses | Description | -------------------------------------------------------------------------------------------------------- | eth1/1/1 | down | 800G | 2001 | 1500 | 10.0.0.0/24 | Test port for diff command | | | | | | | 2400::/64 | | | | | | | | fe80::b4db:91ff:fe95:ff07/64 | | +-----------+--------+-------+------+------+------------------------------+----------------------------+ | eth1/2/1 | down | 200G | 2003 | 9216 | 11.0.0.0/24 | Another test description | | | | | | | 2401::/64 | | | | | | | | fe80::b4db:91ff:fe95:ff07/64 | | [admin@fboss101 benoit]$ ./fboss2-dev config interface eth1/2/1 description 'This is a test.' Successfully set description for interface(s) eth1/2/1 [admin@fboss101 benoit]$ ./fboss2-dev config session diff --- /etc/coop/agent.conf 2025-11-05 12:49:14.497415902 -0800 +++ /home/admin/.fboss2/agent.conf 2025-11-05 12:57:27.123758309 -0800 @@ -2230,7 +2230,7 @@ }, { "conditionalEntropyRehash": false, - "description": "Another test description", + "description": "This is a test.", "drainState": 0, "expectedLLDPValues": { "2": "eth1/6/1" [admin@fboss101 benoit]$ ./fboss2-dev config session commit Config session committed successfully and config reloaded. [admin@fboss101 benoit]$ ./fboss2-dev show interface | head +-----------+--------+-------+------+------+------------------------------+----------------------------+ | Interface | Status | Speed | VLAN | MTU | Addresses | Description | -------------------------------------------------------------------------------------------------------- | eth1/1/1 | down | 800G | 2001 | 1500 | 10.0.0.0/24 | Test port for diff command | | | | | | | 2400::/64 | | | | | | | | fe80::b4db:91ff:fe95:ff07/64 | | +-----------+--------+-------+------+------+------------------------------+----------------------------+ | eth1/2/1 | down | 200G | 2003 | 9216 | 11.0.0.0/24 | This is a test. | | | | | | | 2401::/64 | | | | | | | | fe80::b4db:91ff:fe95:ff07/64 | | ``` Changing two interfaces (or more) at the same time: ``` [admin@fboss101 benoit]$ ./fboss2-dev config interface eth1/1/1 eth1/2/1 description "two at once" Successfully set description for interface(s) eth1/1/1, eth1/2/1 [admin@fboss101 benoit]$ ./fboss2-dev config session diff --- current live config +++ session config @@ -2200,7 +2200,7 @@ "ports": [ { "conditionalEntropyRehash": false, - "description": "two", + "description": "two at once", "drainState": 0, "expectedLLDPValues": { "2": "eth1/5/1" @@ -2230,7 +2230,7 @@ }, { "conditionalEntropyRehash": false, - "description": "two", + "description": "two at once", "drainState": 0, "expectedLLDPValues": { "2": "eth1/6/1" [admin@fboss101 benoit]$ ./fboss2-dev config session commit Config session committed successfully as ede5a52 and config reloaded. [admin@fboss101 benoit]$ ./fboss2-dev show interface eth1/1/1 eth1/2/1 +-----------+--------+-------+------+------+------------------------------+-------------+ | Interface | Status | Speed | VLAN | MTU | Addresses | Description | ----------------------------------------------------------------------------------------- | eth1/1/1 | down | 800G | 2001 | 9000 | 10.0.0.0/24 | two at once | | | | | | | 2400::/64 | | | | | | | | fe80::b4db:91ff:fe95:ff07/64 | | +-----------+--------+-------+------+------+------------------------------+-------------+ | eth1/2/1 | down | 200G | 2003 | 9216 | 11.0.0.0/24 | two at once | | | | | | | 2401::/64 | | | | | | | | fe80::b4db:91ff:fe95:ff07/64 | | +-----------+--------+-------+------+------+------------------------------+-------------+ ``` Referencing an interface that doesn't exist: ``` [admin@fboss101 benoit]$ ./fboss2-dev config interface eth1/9/42 description oopsy Invalid argument: Port(s) or interface(s) not found in configuration: eth1/9/42. Ports must exist in the hardware platform mapping and be defined in the configuration before they can be configured. ``` Nothing changes when mixing valid and nonexistent interface names: ``` [admin@fboss101 benoit]$ ./fboss2-dev config interface eth1/1/1 eth1/9/42 description oopsy Invalid argument: Port(s) or interface(s) not found in configuration: eth1/9/42. Ports must exist in the hardware platform mapping and be defined in the configuration before they can be configured. E0120 14:32:19.177613 42717 CmdHandler.cpp:280] localhost - Error in command execution: Invalid argument: Port(s) or interface(s) not found in configuration: eth1/9/42. Ports must exist in the hardware platform mapping and be defined in the configuration before they can be configured. [admin@fboss101 benoit]$ ./fboss2-dev config session diff No differences between current live config and session config. ``` Reviewed By: shiva-menta Differential Revision: D91058688 Pulled By: joseph5wu fbshipit-source-id: 0d8cafe136f120a7b1163c3dfdb16fced8a2b605
1 parent 5760eba commit 4cf8d36

15 files changed

+525
-0
lines changed

‎cmake/CliFboss2.cmake‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -577,6 +577,9 @@ add_library(fboss2_config_lib
577577
fboss/cli/fboss2/commands/config/CmdConfigAppliedInfo.cpp
578578
fboss/cli/fboss2/commands/config/CmdConfigReload.h
579579
fboss/cli/fboss2/commands/config/CmdConfigReload.cpp
580+
fboss/cli/fboss2/commands/config/interface/CmdConfigInterface.h
581+
fboss/cli/fboss2/commands/config/interface/CmdConfigInterfaceDescription.h
582+
fboss/cli/fboss2/commands/config/interface/CmdConfigInterfaceDescription.cpp
580583
fboss/cli/fboss2/commands/config/history/CmdConfigHistory.h
581584
fboss/cli/fboss2/commands/config/history/CmdConfigHistory.cpp
582585
fboss/cli/fboss2/commands/config/rollback/CmdConfigRollback.h
@@ -587,6 +590,8 @@ add_library(fboss2_config_lib
587590
fboss/cli/fboss2/commands/config/session/CmdConfigSessionDiff.cpp
588591
fboss/cli/fboss2/session/ConfigSession.h
589592
fboss/cli/fboss2/session/ConfigSession.cpp
593+
fboss/cli/fboss2/utils/InterfaceList.h
594+
fboss/cli/fboss2/utils/InterfaceList.cpp
590595
fboss/cli/fboss2/CmdListConfig.cpp
591596
fboss/cli/fboss2/CmdHandlerImplConfig.cpp
592597
)

‎cmake/CliFboss2Test.cmake‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ add_executable(fboss2_cmd_test
3535
fboss/cli/fboss2/test/TestMain.cpp
3636
fboss/cli/fboss2/test/CmdConfigAppliedInfoTest.cpp
3737
fboss/cli/fboss2/test/CmdConfigHistoryTest.cpp
38+
fboss/cli/fboss2/test/CmdConfigInterfaceDescriptionTest.cpp
3839
fboss/cli/fboss2/test/CmdConfigReloadTest.cpp
3940
fboss/cli/fboss2/test/CmdConfigSessionDiffTest.cpp
4041
fboss/cli/fboss2/test/CmdConfigSessionTest.cpp

‎fboss/cli/fboss2/BUCK‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -783,19 +783,24 @@ cpp_library(
783783
"commands/config/CmdConfigAppliedInfo.cpp",
784784
"commands/config/CmdConfigReload.cpp",
785785
"commands/config/history/CmdConfigHistory.cpp",
786+
"commands/config/interface/CmdConfigInterfaceDescription.cpp",
786787
"commands/config/rollback/CmdConfigRollback.cpp",
787788
"commands/config/session/CmdConfigSessionCommit.cpp",
788789
"commands/config/session/CmdConfigSessionDiff.cpp",
789790
"session/ConfigSession.cpp",
791+
"utils/InterfaceList.cpp",
790792
],
791793
headers = [
792794
"commands/config/CmdConfigAppliedInfo.h",
793795
"commands/config/CmdConfigReload.h",
794796
"commands/config/history/CmdConfigHistory.h",
797+
"commands/config/interface/CmdConfigInterface.h",
798+
"commands/config/interface/CmdConfigInterfaceDescription.h",
795799
"commands/config/rollback/CmdConfigRollback.h",
796800
"commands/config/session/CmdConfigSessionCommit.h",
797801
"commands/config/session/CmdConfigSessionDiff.h",
798802
"session/ConfigSession.h",
803+
"utils/InterfaceList.h",
799804
],
800805
exported_deps = [
801806
"fbsource//third-party/fmt:fmt",

‎fboss/cli/fboss2/CmdHandler.h‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,8 @@ class CmdHandler {
169169
RetType result;
170170
try {
171171
result = queryClientHelper(hostInfo);
172+
} catch (std::invalid_argument const& err) {
173+
errStr = folly::to<std::string>("Invalid argument: ", err.what());
172174
} catch (std::exception const& err) {
173175
errStr = folly::to<std::string>("Thrift call failed: '", err.what(), "'");
174176
}

‎fboss/cli/fboss2/CmdHandlerImplConfig.cpp‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616
#include "fboss/cli/fboss2/commands/config/CmdConfigAppliedInfo.h"
1717
#include "fboss/cli/fboss2/commands/config/CmdConfigReload.h"
1818
#include "fboss/cli/fboss2/commands/config/history/CmdConfigHistory.h"
19+
#include "fboss/cli/fboss2/commands/config/interface/CmdConfigInterface.h"
20+
#include "fboss/cli/fboss2/commands/config/interface/CmdConfigInterfaceDescription.h"
1921
#include "fboss/cli/fboss2/commands/config/rollback/CmdConfigRollback.h"
2022
#include "fboss/cli/fboss2/commands/config/session/CmdConfigSessionCommit.h"
2123
#include "fboss/cli/fboss2/commands/config/session/CmdConfigSessionDiff.h"
@@ -25,6 +27,10 @@ namespace facebook::fboss {
2527
template void
2628
CmdHandler<CmdConfigAppliedInfo, CmdConfigAppliedInfoTraits>::run();
2729
template void CmdHandler<CmdConfigReload, CmdConfigReloadTraits>::run();
30+
template void CmdHandler<CmdConfigInterface, CmdConfigInterfaceTraits>::run();
31+
template void CmdHandler<
32+
CmdConfigInterfaceDescription,
33+
CmdConfigInterfaceDescriptionTraits>::run();
2834
template void CmdHandler<CmdConfigHistory, CmdConfigHistoryTraits>::run();
2935
template void CmdHandler<CmdConfigRollback, CmdConfigRollbackTraits>::run();
3036
template void

‎fboss/cli/fboss2/CmdListConfig.cpp‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414
#include "fboss/cli/fboss2/commands/config/CmdConfigAppliedInfo.h"
1515
#include "fboss/cli/fboss2/commands/config/CmdConfigReload.h"
1616
#include "fboss/cli/fboss2/commands/config/history/CmdConfigHistory.h"
17+
#include "fboss/cli/fboss2/commands/config/interface/CmdConfigInterface.h"
18+
#include "fboss/cli/fboss2/commands/config/interface/CmdConfigInterfaceDescription.h"
1719
#include "fboss/cli/fboss2/commands/config/rollback/CmdConfigRollback.h"
1820
#include "fboss/cli/fboss2/commands/config/session/CmdConfigSessionCommit.h"
1921
#include "fboss/cli/fboss2/commands/config/session/CmdConfigSessionDiff.h"
@@ -34,6 +36,20 @@ const CommandTree& kConfigCommandTree() {
3436
commandHandler<CmdConfigHistory>,
3537
argTypeHandler<CmdConfigHistoryTraits>},
3638

39+
{
40+
"config",
41+
"interface",
42+
"Configure interface settings",
43+
commandHandler<CmdConfigInterface>,
44+
argTypeHandler<CmdConfigInterfaceTraits>,
45+
{{
46+
"description",
47+
"Set interface description",
48+
commandHandler<CmdConfigInterfaceDescription>,
49+
argTypeHandler<CmdConfigInterfaceDescriptionTraits>,
50+
}},
51+
},
52+
3753
{
3854
"config",
3955
"session",

‎fboss/cli/fboss2/CmdSubcommands.cpp‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -219,6 +219,9 @@ CLI::App* CmdSubcommands::addCommand(
219219
case utils::ObjectArgTypeId::OBJECT_ARG_TYPE_FAN_PWM:
220220
subCmd->add_option("pwm", args, "Fan PWM (0..100) or 'disable'");
221221
break;
222+
case utils::ObjectArgTypeId::OBJECT_ARG_TYPE_ID_INTERFACE_LIST:
223+
subCmd->add_option("interfaces", args, "Interface(s)");
224+
break;
222225
case utils::ObjectArgTypeId::OBJECT_ARG_TYPE_ID_REVISION_LIST:
223226
subCmd->add_option(
224227
"revisions", args, "Revision(s) in the form 'rN' or 'current'");

‎fboss/cli/fboss2/commands/config/interface/CmdConfigInterface.h‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
/*
2+
* Copyright (c) 2004-present, Facebook, Inc.
3+
* All rights reserved.
4+
*
5+
* This source code is licensed under the BSD-style license found in the
6+
* LICENSE file in the root directory of this source tree. An additional grant
7+
* of patent rights can be found in the PATENTS file in the same directory.
8+
*
9+
*/
10+
11+
#pragma once
12+
13+
#include "fboss/cli/fboss2/CmdHandler.h"
14+
#include "fboss/cli/fboss2/utils/CmdUtils.h"
15+
16+
namespace facebook::fboss {
17+
18+
struct CmdConfigInterfaceTraits : public WriteCommandTraits {
19+
static constexpr utils::ObjectArgTypeId ObjectArgTypeId =
20+
utils::ObjectArgTypeId::OBJECT_ARG_TYPE_ID_PORT_LIST;
21+
using ObjectArgType = std::vector<std::string>;
22+
using RetType = std::string;
23+
};
24+
25+
class CmdConfigInterface
26+
: public CmdHandler<CmdConfigInterface, CmdConfigInterfaceTraits> {
27+
public:
28+
RetType queryClient(
29+
const HostInfo& /* hostInfo */,
30+
const ObjectArgType& /* interfaceNames */) {
31+
throw std::runtime_error(
32+
"Incomplete command, please use one of the subcommands");
33+
}
34+
35+
void printOutput(const RetType& /* model */) {}
36+
};
37+
38+
} // namespace facebook::fboss

‎fboss/cli/fboss2/commands/config/interface/CmdConfigInterfaceDescription.cpp‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
/*
2+
* Copyright (c) 2004-present, Facebook, Inc.
3+
* All rights reserved.
4+
*
5+
* This source code is licensed under the BSD-style license found in the
6+
* LICENSE file in the root directory of this source tree. An additional grant
7+
* of patent rights can be found in the PATENTS file in the same directory.
8+
*
9+
*/
10+
11+
#include "fboss/cli/fboss2/commands/config/interface/CmdConfigInterfaceDescription.h"
12+
13+
#include <folly/Conv.h>
14+
#include "fboss/cli/fboss2/session/ConfigSession.h"
15+
16+
namespace facebook::fboss {
17+
18+
CmdConfigInterfaceDescriptionTraits::RetType
19+
CmdConfigInterfaceDescription::queryClient(
20+
const HostInfo& hostInfo,
21+
const utils::InterfaceList& interfaces,
22+
const ObjectArgType& description) {
23+
if (interfaces.empty()) {
24+
throw std::invalid_argument("No interface name provided");
25+
}
26+
27+
std::string descriptionStr = description.data()[0];
28+
29+
// Update description for all resolved ports
30+
for (const utils::Intf& intf : interfaces) {
31+
cfg::Port* port = intf.getPort();
32+
if (port) {
33+
port->description() = descriptionStr;
34+
}
35+
}
36+
37+
// Save the updated config
38+
ConfigSession::getInstance().saveConfig();
39+
40+
std::string interfaceList = folly::join(", ", interfaces.getNames());
41+
return "Successfully set description for interface(s) " + interfaceList;
42+
}
43+
44+
void CmdConfigInterfaceDescription::printOutput(const RetType& logMsg) {
45+
std::cout << logMsg << std::endl;
46+
}
47+
48+
} // namespace facebook::fboss

‎fboss/cli/fboss2/commands/config/interface/CmdConfigInterfaceDescription.h‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
/*
2+
* Copyright (c) 2004-present, Facebook, Inc.
3+
* All rights reserved.
4+
*
5+
* This source code is licensed under the BSD-style license found in the
6+
* LICENSE file in the root directory of this source tree. An additional grant
7+
* of patent rights can be found in the PATENTS file in the same directory.
8+
*
9+
*/
10+
11+
#pragma once
12+
13+
#include "fboss/cli/fboss2/CmdHandler.h"
14+
#include "fboss/cli/fboss2/commands/config/interface/CmdConfigInterface.h"
15+
#include "fboss/cli/fboss2/utils/CmdUtils.h"
16+
#include "fboss/cli/fboss2/utils/InterfaceList.h"
17+
18+
namespace facebook::fboss {
19+
20+
struct CmdConfigInterfaceDescriptionTraits : public WriteCommandTraits {
21+
using ParentCmd = CmdConfigInterface;
22+
static constexpr utils::ObjectArgTypeId ObjectArgTypeId =
23+
utils::ObjectArgTypeId::OBJECT_ARG_TYPE_ID_MESSAGE;
24+
using ObjectArgType = utils::Message;
25+
using RetType = std::string;
26+
};
27+
28+
class CmdConfigInterfaceDescription : public CmdHandler<
29+
CmdConfigInterfaceDescription,
30+
CmdConfigInterfaceDescriptionTraits> {
31+
public:
32+
using ObjectArgType = CmdConfigInterfaceDescriptionTraits::ObjectArgType;
33+
using RetType = CmdConfigInterfaceDescriptionTraits::RetType;
34+
35+
RetType queryClient(
36+
const HostInfo& hostInfo,
37+
const utils::InterfaceList& interfaces,
38+
const ObjectArgType& description);
39+
40+
void printOutput(const RetType& logMsg);
41+
};
42+
43+
} // namespace facebook::fboss

0 commit comments

Comments
 (0)