1 /* 2 // Copyright (c) 2018 Intel Corporation 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 #pragma once 17 18 #include <boost/container/flat_map.hpp> 19 #include <boost/container/flat_set.hpp> 20 #include <dbus_singleton.hpp> 21 #include <error_messages.hpp> 22 #include <node.hpp> 23 #include <optional> 24 #include <utils/json_utils.hpp> 25 #include <variant> 26 27 namespace redfish 28 { 29 30 /** 31 * DBus types primitives for several generic DBus interfaces 32 * TODO(Pawel) consider move this to separate file into boost::dbus 33 */ 34 using PropertiesMapType = boost::container::flat_map< 35 std::string, std::variant<std::string, bool, uint8_t, int16_t, uint16_t, 36 int32_t, uint32_t, int64_t, uint64_t, double>>; 37 38 using GetManagedObjects = std::vector<std::pair< 39 sdbusplus::message::object_path, 40 std::vector<std::pair< 41 std::string, 42 boost::container::flat_map< 43 std::string, sdbusplus::message::variant< 44 std::string, bool, uint8_t, int16_t, uint16_t, 45 int32_t, uint32_t, int64_t, uint64_t, double, 46 std::vector<std::string>>>>>>>; 47 48 enum class LinkType 49 { 50 Local, 51 Global 52 }; 53 54 /** 55 * Structure for keeping IPv4 data required by Redfish 56 */ 57 struct IPv4AddressData 58 { 59 std::string id; 60 std::string address; 61 std::string domain; 62 std::string gateway; 63 std::string netmask; 64 std::string origin; 65 LinkType linktype; 66 67 bool operator<(const IPv4AddressData &obj) const 68 { 69 return id < obj.id; 70 } 71 }; 72 73 /** 74 * Structure for keeping IPv6 data required by Redfish 75 */ 76 struct IPv6AddressData 77 { 78 std::string id; 79 std::string address; 80 std::string origin; 81 uint8_t prefixLength; 82 83 bool operator<(const IPv6AddressData &obj) const 84 { 85 return id < obj.id; 86 } 87 }; 88 /** 89 * Structure for keeping basic single Ethernet Interface information 90 * available from DBus 91 */ 92 struct EthernetInterfaceData 93 { 94 uint32_t speed; 95 bool auto_neg; 96 bool DHCPEnabled; 97 std::string hostname; 98 std::string default_gateway; 99 std::string ipv6_default_gateway; 100 std::string mac_address; 101 std::vector<std::uint32_t> vlan_id; 102 std::vector<std::string> nameservers; 103 std::vector<std::string> domainnames; 104 }; 105 106 // Helper function that changes bits netmask notation (i.e. /24) 107 // into full dot notation 108 inline std::string getNetmask(unsigned int bits) 109 { 110 uint32_t value = 0xffffffff << (32 - bits); 111 std::string netmask = std::to_string((value >> 24) & 0xff) + "." + 112 std::to_string((value >> 16) & 0xff) + "." + 113 std::to_string((value >> 8) & 0xff) + "." + 114 std::to_string(value & 0xff); 115 return netmask; 116 } 117 118 inline std::string 119 translateAddressOriginDbusToRedfish(const std::string &inputOrigin, 120 bool isIPv4) 121 { 122 if (inputOrigin == "xyz.openbmc_project.Network.IP.AddressOrigin.Static") 123 { 124 return "Static"; 125 } 126 if (inputOrigin == "xyz.openbmc_project.Network.IP.AddressOrigin.LinkLocal") 127 { 128 if (isIPv4) 129 { 130 return "IPv4LinkLocal"; 131 } 132 else 133 { 134 return "LinkLocal"; 135 } 136 } 137 if (inputOrigin == "xyz.openbmc_project.Network.IP.AddressOrigin.DHCP") 138 { 139 if (isIPv4) 140 { 141 return "DHCP"; 142 } 143 else 144 { 145 return "DHCPv6"; 146 } 147 } 148 if (inputOrigin == "xyz.openbmc_project.Network.IP.AddressOrigin.SLAAC") 149 { 150 return "SLAAC"; 151 } 152 return ""; 153 } 154 155 inline bool extractEthernetInterfaceData(const std::string ðiface_id, 156 const GetManagedObjects &dbus_data, 157 EthernetInterfaceData ðData) 158 { 159 bool idFound = false; 160 for (const auto &objpath : dbus_data) 161 { 162 for (const auto &ifacePair : objpath.second) 163 { 164 if (objpath.first == "/xyz/openbmc_project/network/" + ethiface_id) 165 { 166 idFound = true; 167 if (ifacePair.first == "xyz.openbmc_project.Network.MACAddress") 168 { 169 for (const auto &propertyPair : ifacePair.second) 170 { 171 if (propertyPair.first == "MACAddress") 172 { 173 const std::string *mac = 174 std::get_if<std::string>(&propertyPair.second); 175 if (mac != nullptr) 176 { 177 ethData.mac_address = *mac; 178 } 179 } 180 } 181 } 182 else if (ifacePair.first == "xyz.openbmc_project.Network.VLAN") 183 { 184 for (const auto &propertyPair : ifacePair.second) 185 { 186 if (propertyPair.first == "Id") 187 { 188 const uint32_t *id = 189 std::get_if<uint32_t>(&propertyPair.second); 190 if (id != nullptr) 191 { 192 ethData.vlan_id.push_back(*id); 193 } 194 } 195 } 196 } 197 else if (ifacePair.first == 198 "xyz.openbmc_project.Network.EthernetInterface") 199 { 200 for (const auto &propertyPair : ifacePair.second) 201 { 202 if (propertyPair.first == "AutoNeg") 203 { 204 const bool *auto_neg = 205 std::get_if<bool>(&propertyPair.second); 206 if (auto_neg != nullptr) 207 { 208 ethData.auto_neg = *auto_neg; 209 } 210 } 211 else if (propertyPair.first == "Speed") 212 { 213 const uint32_t *speed = 214 std::get_if<uint32_t>(&propertyPair.second); 215 if (speed != nullptr) 216 { 217 ethData.speed = *speed; 218 } 219 } 220 else if (propertyPair.first == "Nameservers") 221 { 222 const std::vector<std::string> *nameservers = 223 sdbusplus::message::variant_ns::get_if< 224 std::vector<std::string>>( 225 &propertyPair.second); 226 if (nameservers != nullptr) 227 { 228 ethData.nameservers = std::move(*nameservers); 229 } 230 } 231 else if (propertyPair.first == "DHCPEnabled") 232 { 233 const bool *DHCPEnabled = 234 std::get_if<bool>(&propertyPair.second); 235 if (DHCPEnabled != nullptr) 236 { 237 ethData.DHCPEnabled = *DHCPEnabled; 238 } 239 } 240 else if (propertyPair.first == "DomainName") 241 { 242 const std::vector<std::string> *domainNames = 243 sdbusplus::message::variant_ns::get_if< 244 std::vector<std::string>>( 245 &propertyPair.second); 246 if (domainNames != nullptr) 247 { 248 ethData.domainnames = std::move(*domainNames); 249 } 250 } 251 } 252 } 253 } 254 // System configuration shows up in the global namespace, so no need 255 // to check eth number 256 if (ifacePair.first == 257 "xyz.openbmc_project.Network.SystemConfiguration") 258 { 259 for (const auto &propertyPair : ifacePair.second) 260 { 261 if (propertyPair.first == "HostName") 262 { 263 const std::string *hostname = 264 sdbusplus::message::variant_ns::get_if<std::string>( 265 &propertyPair.second); 266 if (hostname != nullptr) 267 { 268 ethData.hostname = *hostname; 269 } 270 } 271 else if (propertyPair.first == "DefaultGateway") 272 { 273 const std::string *defaultGateway = 274 sdbusplus::message::variant_ns::get_if<std::string>( 275 &propertyPair.second); 276 if (defaultGateway != nullptr) 277 { 278 ethData.default_gateway = *defaultGateway; 279 } 280 } 281 else if (propertyPair.first == "DefaultGateway6") 282 { 283 const std::string *defaultGateway6 = 284 sdbusplus::message::variant_ns::get_if<std::string>( 285 &propertyPair.second); 286 if (defaultGateway6 != nullptr) 287 { 288 ethData.ipv6_default_gateway = *defaultGateway6; 289 } 290 } 291 } 292 } 293 } 294 } 295 return idFound; 296 } 297 298 // Helper function that extracts data for single ethernet ipv6 address 299 inline void extractIPV6Data( 300 const std::string ðiface_id, const GetManagedObjects &dbus_data, 301 boost::container::flat_set<IPv6AddressData> &ipv6_config, 302 boost::container::flat_set<IPv6AddressData> &ipv6_static_config) 303 { 304 const std::string ipv6PathStart = 305 "/xyz/openbmc_project/network/" + ethiface_id + "/ipv6/"; 306 307 // Since there might be several IPv6 configurations aligned with 308 // single ethernet interface, loop over all of them 309 for (const auto &objpath : dbus_data) 310 { 311 // Check if proper pattern for object path appears 312 if (boost::starts_with(objpath.first.str, ipv6PathStart)) 313 { 314 for (auto &interface : objpath.second) 315 { 316 if (interface.first == "xyz.openbmc_project.Network.IP") 317 { 318 // Instance IPv6AddressData structure, and set as 319 // appropriate 320 std::pair< 321 boost::container::flat_set<IPv6AddressData>::iterator, 322 bool> 323 it = ipv6_config.insert( 324 {objpath.first.str.substr(ipv6PathStart.size())}); 325 IPv6AddressData &ipv6_address = *it.first; 326 for (auto &property : interface.second) 327 { 328 if (property.first == "Address") 329 { 330 const std::string *address = 331 std::get_if<std::string>(&property.second); 332 if (address != nullptr) 333 { 334 ipv6_address.address = *address; 335 } 336 } 337 else if (property.first == "Origin") 338 { 339 const std::string *origin = 340 std::get_if<std::string>(&property.second); 341 if (origin != nullptr) 342 { 343 ipv6_address.origin = 344 translateAddressOriginDbusToRedfish(*origin, 345 false); 346 } 347 } 348 else if (property.first == "PrefixLength") 349 { 350 const uint8_t *prefix = 351 std::get_if<uint8_t>(&property.second); 352 if (prefix != nullptr) 353 { 354 ipv6_address.prefixLength = *prefix; 355 } 356 } 357 else 358 { 359 BMCWEB_LOG_ERROR 360 << "Got extra property: " << property.first 361 << " on the " << objpath.first.str << " object"; 362 } 363 } 364 if (ipv6_address.origin == "Static") 365 { 366 std::pair<boost::container::flat_set< 367 IPv6AddressData>::iterator, 368 bool> 369 iter = ipv6_static_config.insert( 370 {objpath.first.str.substr( 371 ipv6PathStart.size())}); 372 IPv6AddressData &ipv6_static_address = *iter.first; 373 374 ipv6_static_address.address = ipv6_address.address; 375 ipv6_static_address.prefixLength = 376 ipv6_address.prefixLength; 377 } 378 } 379 } 380 } 381 } 382 } 383 384 // Helper function that extracts data for single ethernet ipv4 address 385 inline void extractIPData( 386 const std::string ðiface_id, const GetManagedObjects &dbus_data, 387 boost::container::flat_set<IPv4AddressData> &ipv4_config, 388 boost::container::flat_set<IPv4AddressData> &ipv4_static_config) 389 { 390 const std::string ipv4PathStart = 391 "/xyz/openbmc_project/network/" + ethiface_id + "/ipv4/"; 392 393 // Since there might be several IPv4 configurations aligned with 394 // single ethernet interface, loop over all of them 395 for (const auto &objpath : dbus_data) 396 { 397 // Check if proper pattern for object path appears 398 if (boost::starts_with(objpath.first.str, ipv4PathStart)) 399 { 400 for (auto &interface : objpath.second) 401 { 402 if (interface.first == "xyz.openbmc_project.Network.IP") 403 { 404 // Instance IPv4AddressData structure, and set as 405 // appropriate 406 std::pair< 407 boost::container::flat_set<IPv4AddressData>::iterator, 408 bool> 409 it = ipv4_config.insert( 410 {objpath.first.str.substr(ipv4PathStart.size())}); 411 IPv4AddressData &ipv4_address = *it.first; 412 for (auto &property : interface.second) 413 { 414 if (property.first == "Address") 415 { 416 const std::string *address = 417 std::get_if<std::string>(&property.second); 418 if (address != nullptr) 419 { 420 ipv4_address.address = *address; 421 } 422 } 423 else if (property.first == "Gateway") 424 { 425 const std::string *gateway = 426 std::get_if<std::string>(&property.second); 427 if (gateway != nullptr) 428 { 429 ipv4_address.gateway = *gateway; 430 } 431 } 432 else if (property.first == "Origin") 433 { 434 const std::string *origin = 435 std::get_if<std::string>(&property.second); 436 if (origin != nullptr) 437 { 438 ipv4_address.origin = 439 translateAddressOriginDbusToRedfish(*origin, 440 true); 441 } 442 } 443 else if (property.first == "PrefixLength") 444 { 445 const uint8_t *mask = 446 std::get_if<uint8_t>(&property.second); 447 if (mask != nullptr) 448 { 449 // convert it to the string 450 ipv4_address.netmask = getNetmask(*mask); 451 } 452 } 453 else 454 { 455 BMCWEB_LOG_ERROR 456 << "Got extra property: " << property.first 457 << " on the " << objpath.first.str << " object"; 458 } 459 } 460 461 if (ipv4_address.origin == "Static") 462 { 463 IPv4AddressData ipv4_static_address = { 464 objpath.first.str.substr(ipv4PathStart.size())}; 465 ipv4_static_address.address = ipv4_address.address; 466 ipv4_static_address.gateway = ipv4_address.gateway; 467 ipv4_static_address.netmask = ipv4_address.netmask; 468 ipv4_static_config.emplace(ipv4_static_address); 469 } 470 471 // Check if given address is local, or global 472 ipv4_address.linktype = 473 boost::starts_with(ipv4_address.address, "169.254.") 474 ? LinkType::Local 475 : LinkType::Global; 476 } 477 } 478 } 479 } 480 } 481 482 /** 483 * @brief Sets given Id on the given VLAN interface through D-Bus 484 * 485 * @param[in] ifaceId Id of VLAN interface that should be modified 486 * @param[in] inputVlanId New ID of the VLAN 487 * @param[in] callback Function that will be called after the operation 488 * 489 * @return None. 490 */ 491 template <typename CallbackFunc> 492 void changeVlanId(const std::string &ifaceId, const uint32_t &inputVlanId, 493 CallbackFunc &&callback) 494 { 495 crow::connections::systemBus->async_method_call( 496 callback, "xyz.openbmc_project.Network", 497 std::string("/xyz/openbmc_project/network/") + ifaceId, 498 "org.freedesktop.DBus.Properties", "Set", 499 "xyz.openbmc_project.Network.VLAN", "Id", 500 std::variant<uint32_t>(inputVlanId)); 501 } 502 503 /** 504 * @brief Helper function that verifies IP address to check if it is in 505 * proper format. If bits pointer is provided, also calculates active 506 * bit count for Subnet Mask. 507 * 508 * @param[in] ip IP that will be verified 509 * @param[out] bits Calculated mask in bits notation 510 * 511 * @return true in case of success, false otherwise 512 */ 513 inline bool ipv4VerifyIpAndGetBitcount(const std::string &ip, 514 uint8_t *bits = nullptr) 515 { 516 std::vector<std::string> bytesInMask; 517 518 boost::split(bytesInMask, ip, boost::is_any_of(".")); 519 520 static const constexpr int ipV4AddressSectionsCount = 4; 521 if (bytesInMask.size() != ipV4AddressSectionsCount) 522 { 523 return false; 524 } 525 526 if (bits != nullptr) 527 { 528 *bits = 0; 529 } 530 531 char *endPtr; 532 long previousValue = 255; 533 bool firstZeroInByteHit; 534 for (const std::string &byte : bytesInMask) 535 { 536 if (byte.empty()) 537 { 538 return false; 539 } 540 541 // Use strtol instead of stroi to avoid exceptions 542 long value = std::strtol(byte.c_str(), &endPtr, 10); 543 544 // endPtr should point to the end of the string, otherwise given string 545 // is not 100% number 546 if (*endPtr != '\0') 547 { 548 return false; 549 } 550 551 // Value should be contained in byte 552 if (value < 0 || value > 255) 553 { 554 return false; 555 } 556 557 if (bits != nullptr) 558 { 559 // Mask has to be continuous between bytes 560 if (previousValue != 255 && value != 0) 561 { 562 return false; 563 } 564 565 // Mask has to be continuous inside bytes 566 firstZeroInByteHit = false; 567 568 // Count bits 569 for (int bitIdx = 7; bitIdx >= 0; bitIdx--) 570 { 571 if (value & (1 << bitIdx)) 572 { 573 if (firstZeroInByteHit) 574 { 575 // Continuity not preserved 576 return false; 577 } 578 else 579 { 580 (*bits)++; 581 } 582 } 583 else 584 { 585 firstZeroInByteHit = true; 586 } 587 } 588 } 589 590 previousValue = value; 591 } 592 593 return true; 594 } 595 596 /** 597 * @brief Changes IPv4 address type property (Address, Gateway) 598 * 599 * @param[in] ifaceId Id of interface whose IP should be modified 600 * @param[in] ipIdx Index of IP in input array that should be modified 601 * @param[in] ipHash DBus Hash id of modified IP 602 * @param[in] name Name of field in JSON representation 603 * @param[in] newValue New value that should be written 604 * @param[io] asyncResp Response object that will be returned to client 605 * 606 * @return true if give IP is valid and has been sent do D-Bus, false 607 * otherwise 608 */ 609 inline void changeIPv4AddressProperty( 610 const std::string &ifaceId, int ipIdx, const std::string &ipHash, 611 const std::string &name, const std::string &newValue, 612 const std::shared_ptr<AsyncResp> asyncResp) 613 { 614 auto callback = 615 [asyncResp, ipIdx, name{std::string(name)}, 616 newValue{std::move(newValue)}](const boost::system::error_code ec) { 617 if (ec) 618 { 619 messages::internalError(asyncResp->res); 620 } 621 }; 622 623 crow::connections::systemBus->async_method_call( 624 std::move(callback), "xyz.openbmc_project.Network", 625 "/xyz/openbmc_project/network/" + ifaceId + "/ipv4/" + ipHash, 626 "org.freedesktop.DBus.Properties", "Set", 627 "xyz.openbmc_project.Network.IP", name, 628 std::variant<std::string>(newValue)); 629 } 630 631 /** 632 * @brief Modifies SubnetMask for given IP 633 * 634 * @param[in] ifaceId Id of interface whose IP should be modified 635 * @param[in] ipIdx Index of IP in input array that should be 636 * modified 637 * @param[in] ipHash DBus Hash id of modified IP 638 * @param[in] newValue Mask as PrefixLength in bitcount 639 * @param[io] asyncResp Response object that will be returned to client 640 * 641 * @return None 642 */ 643 inline void changeIPv4SubnetMaskProperty(const std::string &ifaceId, int ipIdx, 644 const std::string &ipHash, 645 uint8_t &newValue, 646 std::shared_ptr<AsyncResp> asyncResp) 647 { 648 auto callback = [asyncResp, ipIdx](const boost::system::error_code ec) { 649 if (ec) 650 { 651 messages::internalError(asyncResp->res); 652 } 653 }; 654 655 crow::connections::systemBus->async_method_call( 656 std::move(callback), "xyz.openbmc_project.Network", 657 "/xyz/openbmc_project/network/" + ifaceId + "/ipv4/" + ipHash, 658 "org.freedesktop.DBus.Properties", "Set", 659 "xyz.openbmc_project.Network.IP", "PrefixLength", 660 std::variant<uint8_t>(newValue)); 661 } 662 663 /** 664 * @brief Deletes given IPv4 665 * 666 * @param[in] ifaceId Id of interface whose IP should be deleted 667 * @param[in] ipHash DBus Hash id of IP that should be deleted 668 * @param[io] asyncResp Response object that will be returned to client 669 * 670 * @return None 671 */ 672 inline void deleteIPv4(const std::string &ifaceId, const std::string &ipHash, 673 const std::shared_ptr<AsyncResp> asyncResp) 674 { 675 crow::connections::systemBus->async_method_call( 676 [asyncResp](const boost::system::error_code ec) { 677 if (ec) 678 { 679 messages::internalError(asyncResp->res); 680 } 681 }, 682 "xyz.openbmc_project.Network", 683 "/xyz/openbmc_project/network/" + ifaceId + "/ipv4/" + ipHash, 684 "xyz.openbmc_project.Object.Delete", "Delete"); 685 } 686 687 /** 688 * @brief Creates IPv4 with given data 689 * 690 * @param[in] ifaceId Id of interface whose IP should be deleted 691 * @param[in] ipIdx Index of IP in input array that should be deleted 692 * @param[in] ipHash DBus Hash id of IP that should be deleted 693 * @param[io] asyncResp Response object that will be returned to client 694 * 695 * @return None 696 */ 697 inline void createIPv4(const std::string &ifaceId, unsigned int ipIdx, 698 uint8_t subnetMask, const std::string &gateway, 699 const std::string &address, 700 std::shared_ptr<AsyncResp> asyncResp) 701 { 702 auto createIpHandler = [asyncResp](const boost::system::error_code ec) { 703 if (ec) 704 { 705 messages::internalError(asyncResp->res); 706 } 707 }; 708 709 crow::connections::systemBus->async_method_call( 710 std::move(createIpHandler), "xyz.openbmc_project.Network", 711 "/xyz/openbmc_project/network/" + ifaceId, 712 "xyz.openbmc_project.Network.IP.Create", "IP", 713 "xyz.openbmc_project.Network.IP.Protocol.IPv4", address, subnetMask, 714 gateway); 715 } 716 717 /** 718 * @brief Deletes given IPv6 719 * 720 * @param[in] ifaceId Id of interface whose IP should be deleted 721 * @param[in] ipHash DBus Hash id of IP that should be deleted 722 * @param[io] asyncResp Response object that will be returned to client 723 * 724 * @return None 725 */ 726 inline void deleteIPv6(const std::string &ifaceId, const std::string &ipHash, 727 const std::shared_ptr<AsyncResp> asyncResp) 728 { 729 crow::connections::systemBus->async_method_call( 730 [asyncResp](const boost::system::error_code ec) { 731 if (ec) 732 { 733 messages::internalError(asyncResp->res); 734 } 735 }, 736 "xyz.openbmc_project.Network", 737 "/xyz/openbmc_project/network/" + ifaceId + "/ipv6/" + ipHash, 738 "xyz.openbmc_project.Object.Delete", "Delete"); 739 } 740 741 /** 742 * @brief Creates IPv6 with given data 743 * 744 * @param[in] ifaceId Id of interface whose IP should be added 745 * @param[in] ipIdx Index of IP in input array that should be added 746 * @param[in] prefixLength Prefix length that needs to be added 747 * @param[in] address IP address that needs to be added 748 * @param[io] asyncResp Response object that will be returned to client 749 * 750 * @return None 751 */ 752 inline void createIPv6(const std::string &ifaceId, unsigned int ipIdx, 753 uint8_t prefixLength, const std::string &address, 754 std::shared_ptr<AsyncResp> asyncResp) 755 { 756 auto createIpHandler = [asyncResp](const boost::system::error_code ec) { 757 if (ec) 758 { 759 messages::internalError(asyncResp->res); 760 } 761 }; 762 // Passing null for gateway, as per redfish spec IPv6StaticAddresses object 763 // does not have assosiated gateway property 764 crow::connections::systemBus->async_method_call( 765 std::move(createIpHandler), "xyz.openbmc_project.Network", 766 "/xyz/openbmc_project/network/" + ifaceId, 767 "xyz.openbmc_project.Network.IP.Create", "IP", 768 "xyz.openbmc_project.Network.IP.Protocol.IPv6", address, prefixLength, 769 ""); 770 } 771 772 using GetAllPropertiesType = 773 boost::container::flat_map<std::string, sdbusplus::message::variant<bool>>; 774 775 inline void getDHCPConfigData(const std::shared_ptr<AsyncResp> asyncResp) 776 { 777 auto getConfig = [asyncResp](const boost::system::error_code error_code, 778 const GetAllPropertiesType &dbus_data) { 779 if (error_code) 780 { 781 BMCWEB_LOG_ERROR << "D-Bus response error: " << error_code; 782 messages::internalError(asyncResp->res); 783 return; 784 } 785 nlohmann::json &DHCPConfigTypeJson = asyncResp->res.jsonValue["DHCPv4"]; 786 for (const auto &property : dbus_data) 787 { 788 auto value = 789 sdbusplus::message::variant_ns::get_if<bool>(&property.second); 790 791 if (value == nullptr) 792 { 793 continue; 794 } 795 if (property.first == "DNSEnabled") 796 { 797 DHCPConfigTypeJson["UseDNSServers"] = *value; 798 } 799 else if (property.first == "HostNameEnabled") 800 { 801 DHCPConfigTypeJson["UseDomainName"] = *value; 802 } 803 else if (property.first == "NTPEnabled") 804 { 805 DHCPConfigTypeJson["UseNTPServers"] = *value; 806 } 807 } 808 }; 809 crow::connections::systemBus->async_method_call( 810 std::move(getConfig), "xyz.openbmc_project.Network", 811 "/xyz/openbmc_project/network/config/dhcp", 812 "org.freedesktop.DBus.Properties", "GetAll", 813 "xyz.openbmc_project.Network.DHCPConfiguration"); 814 } 815 816 /** 817 * Function that retrieves all properties for given Ethernet Interface 818 * Object 819 * from EntityManager Network Manager 820 * @param ethiface_id a eth interface id to query on DBus 821 * @param callback a function that shall be called to convert Dbus output 822 * into JSON 823 */ 824 template <typename CallbackFunc> 825 void getEthernetIfaceData(const std::string ðiface_id, 826 CallbackFunc &&callback) 827 { 828 crow::connections::systemBus->async_method_call( 829 [ethiface_id{std::string{ethiface_id}}, callback{std::move(callback)}]( 830 const boost::system::error_code error_code, 831 const GetManagedObjects &resp) { 832 EthernetInterfaceData ethData{}; 833 boost::container::flat_set<IPv4AddressData> ipv4Data; 834 boost::container::flat_set<IPv4AddressData> ipv4StaticData; 835 boost::container::flat_set<IPv6AddressData> ipv6Data; 836 boost::container::flat_set<IPv6AddressData> ipv6StaticData; 837 838 if (error_code) 839 { 840 callback(false, ethData, ipv4Data, ipv4StaticData, ipv6Data, 841 ipv6StaticData); 842 return; 843 } 844 845 bool found = 846 extractEthernetInterfaceData(ethiface_id, resp, ethData); 847 if (!found) 848 { 849 callback(false, ethData, ipv4Data, ipv4StaticData, ipv6Data, 850 ipv6StaticData); 851 return; 852 } 853 854 extractIPData(ethiface_id, resp, ipv4Data, ipv4StaticData); 855 // Fix global GW 856 for (IPv4AddressData &ipv4 : ipv4Data) 857 { 858 if (((ipv4.linktype == LinkType::Global) && 859 (ipv4.gateway == "0.0.0.0")) || 860 (ipv4.origin == "DHCP")) 861 { 862 ipv4.gateway = ethData.default_gateway; 863 } 864 } 865 866 extractIPV6Data(ethiface_id, resp, ipv6Data, ipv6StaticData); 867 // Finally make a callback with usefull data 868 callback(true, ethData, ipv4Data, ipv4StaticData, ipv6Data, 869 ipv6StaticData); 870 }, 871 "xyz.openbmc_project.Network", "/xyz/openbmc_project/network", 872 "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 873 }; 874 875 /** 876 * Function that retrieves all Ethernet Interfaces available through Network 877 * Manager 878 * @param callback a function that shall be called to convert Dbus output 879 * into JSON. 880 */ 881 template <typename CallbackFunc> 882 void getEthernetIfaceList(CallbackFunc &&callback) 883 { 884 crow::connections::systemBus->async_method_call( 885 [callback{std::move(callback)}]( 886 const boost::system::error_code error_code, 887 GetManagedObjects &resp) { 888 // Callback requires vector<string> to retrieve all available 889 // ethernet interfaces 890 boost::container::flat_set<std::string> iface_list; 891 iface_list.reserve(resp.size()); 892 if (error_code) 893 { 894 callback(false, iface_list); 895 return; 896 } 897 898 // Iterate over all retrieved ObjectPaths. 899 for (const auto &objpath : resp) 900 { 901 // And all interfaces available for certain ObjectPath. 902 for (const auto &interface : objpath.second) 903 { 904 // If interface is 905 // xyz.openbmc_project.Network.EthernetInterface, this is 906 // what we're looking for. 907 if (interface.first == 908 "xyz.openbmc_project.Network.EthernetInterface") 909 { 910 // Cut out everyting until last "/", ... 911 const std::string &iface_id = objpath.first.str; 912 std::size_t last_pos = iface_id.rfind("/"); 913 if (last_pos != std::string::npos) 914 { 915 // and put it into output vector. 916 iface_list.emplace(iface_id.substr(last_pos + 1)); 917 } 918 } 919 } 920 } 921 // Finally make a callback with useful data 922 callback(true, iface_list); 923 }, 924 "xyz.openbmc_project.Network", "/xyz/openbmc_project/network", 925 "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 926 }; 927 928 /** 929 * EthernetCollection derived class for delivering Ethernet Collection Schema 930 */ 931 class EthernetCollection : public Node 932 { 933 public: 934 template <typename CrowApp> 935 EthernetCollection(CrowApp &app) : 936 Node(app, "/redfish/v1/Managers/bmc/EthernetInterfaces/") 937 { 938 entityPrivileges = { 939 {boost::beast::http::verb::get, {{"Login"}}}, 940 {boost::beast::http::verb::head, {{"Login"}}}, 941 {boost::beast::http::verb::patch, {{"ConfigureComponents"}}}, 942 {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, 943 {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, 944 {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; 945 } 946 947 private: 948 /** 949 * Functions triggers appropriate requests on DBus 950 */ 951 void doGet(crow::Response &res, const crow::Request &req, 952 const std::vector<std::string> ¶ms) override 953 { 954 res.jsonValue["@odata.type"] = 955 "#EthernetInterfaceCollection.EthernetInterfaceCollection"; 956 res.jsonValue["@odata.context"] = 957 "/redfish/v1/" 958 "$metadata#EthernetInterfaceCollection.EthernetInterfaceCollection"; 959 res.jsonValue["@odata.id"] = 960 "/redfish/v1/Managers/bmc/EthernetInterfaces"; 961 res.jsonValue["Name"] = "Ethernet Network Interface Collection"; 962 res.jsonValue["Description"] = 963 "Collection of EthernetInterfaces for this Manager"; 964 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 965 // Get eth interface list, and call the below callback for JSON 966 // preparation 967 getEthernetIfaceList( 968 [asyncResp]( 969 const bool &success, 970 const boost::container::flat_set<std::string> &iface_list) { 971 if (!success) 972 { 973 messages::internalError(asyncResp->res); 974 return; 975 } 976 977 nlohmann::json &iface_array = 978 asyncResp->res.jsonValue["Members"]; 979 iface_array = nlohmann::json::array(); 980 std::string tag = "_"; 981 for (const std::string &iface_item : iface_list) 982 { 983 std::size_t found = iface_item.find(tag); 984 if (found == std::string::npos) 985 { 986 iface_array.push_back( 987 {{"@odata.id", 988 "/redfish/v1/Managers/bmc/EthernetInterfaces/" + 989 iface_item}}); 990 } 991 } 992 993 asyncResp->res.jsonValue["Members@odata.count"] = 994 iface_array.size(); 995 asyncResp->res.jsonValue["@odata.id"] = 996 "/redfish/v1/Managers/bmc/EthernetInterfaces"; 997 }); 998 } 999 }; 1000 1001 /** 1002 * EthernetInterface derived class for delivering Ethernet Schema 1003 */ 1004 class EthernetInterface : public Node 1005 { 1006 public: 1007 /* 1008 * Default Constructor 1009 */ 1010 template <typename CrowApp> 1011 EthernetInterface(CrowApp &app) : 1012 Node(app, "/redfish/v1/Managers/bmc/EthernetInterfaces/<str>/", 1013 std::string()) 1014 { 1015 entityPrivileges = { 1016 {boost::beast::http::verb::get, {{"Login"}}}, 1017 {boost::beast::http::verb::head, {{"Login"}}}, 1018 {boost::beast::http::verb::patch, {{"ConfigureComponents"}}}, 1019 {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, 1020 {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, 1021 {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; 1022 } 1023 1024 private: 1025 void handleHostnamePatch(const std::string &hostname, 1026 const std::shared_ptr<AsyncResp> asyncResp) 1027 { 1028 asyncResp->res.jsonValue["HostName"] = hostname; 1029 crow::connections::systemBus->async_method_call( 1030 [asyncResp](const boost::system::error_code ec) { 1031 if (ec) 1032 { 1033 messages::internalError(asyncResp->res); 1034 } 1035 }, 1036 "xyz.openbmc_project.Network", 1037 "/xyz/openbmc_project/network/config", 1038 "org.freedesktop.DBus.Properties", "Set", 1039 "xyz.openbmc_project.Network.SystemConfiguration", "HostName", 1040 std::variant<std::string>(hostname)); 1041 } 1042 1043 void handleMACAddressPatch(const std::string &ifaceId, 1044 const std::string &macAddress, 1045 const std::shared_ptr<AsyncResp> &asyncResp) 1046 { 1047 crow::connections::systemBus->async_method_call( 1048 [asyncResp, macAddress](const boost::system::error_code ec) { 1049 if (ec) 1050 { 1051 messages::internalError(asyncResp->res); 1052 return; 1053 } 1054 }, 1055 "xyz.openbmc_project.Network", 1056 "/xyz/openbmc_project/network/" + ifaceId, 1057 "org.freedesktop.DBus.Properties", "Set", 1058 "xyz.openbmc_project.Network.MACAddress", "MACAddress", 1059 std::variant<std::string>(macAddress)); 1060 } 1061 1062 void setDHCPEnabled(const std::string &ifaceId, 1063 const std::string &propertyName, const bool &value, 1064 const std::shared_ptr<AsyncResp> asyncResp) 1065 { 1066 crow::connections::systemBus->async_method_call( 1067 [asyncResp](const boost::system::error_code ec) { 1068 if (ec) 1069 { 1070 BMCWEB_LOG_ERROR << "D-Bus responses error: " << ec; 1071 messages::internalError(asyncResp->res); 1072 return; 1073 } 1074 }, 1075 "xyz.openbmc_project.Network", 1076 "/xyz/openbmc_project/network/" + ifaceId, 1077 "org.freedesktop.DBus.Properties", "Set", 1078 "xyz.openbmc_project.Network.EthernetInterface", propertyName, 1079 std::variant<bool>{value}); 1080 } 1081 void setDHCPv4Config(const std::string &propertyName, const bool &value, 1082 const std::shared_ptr<AsyncResp> asyncResp) 1083 { 1084 BMCWEB_LOG_DEBUG << propertyName << " = " << value; 1085 crow::connections::systemBus->async_method_call( 1086 [asyncResp](const boost::system::error_code ec) { 1087 if (ec) 1088 { 1089 BMCWEB_LOG_ERROR << "D-Bus responses error: " << ec; 1090 messages::internalError(asyncResp->res); 1091 return; 1092 } 1093 }, 1094 "xyz.openbmc_project.Network", 1095 "/xyz/openbmc_project/network/config/dhcp", 1096 "org.freedesktop.DBus.Properties", "Set", 1097 "xyz.openbmc_project.Network.DHCPConfiguration", propertyName, 1098 std::variant<bool>{value}); 1099 } 1100 1101 void handleDHCPv4Patch(const std::string &ifaceId, nlohmann::json &input, 1102 const std::shared_ptr<AsyncResp> asyncResp) 1103 { 1104 std::optional<bool> dhcpEnabled; 1105 std::optional<bool> useDNSServers; 1106 std::optional<bool> useDomainName; 1107 std::optional<bool> useNTPServers; 1108 1109 if (!json_util::readJson(input, asyncResp->res, "DHCPEnabled", 1110 dhcpEnabled, "UseDNSServers", useDNSServers, 1111 "UseDomainName", useDomainName, 1112 "UseNTPServers", useNTPServers)) 1113 { 1114 return; 1115 } 1116 1117 if (dhcpEnabled) 1118 { 1119 BMCWEB_LOG_DEBUG << "set DHCPEnabled..."; 1120 setDHCPEnabled(ifaceId, "DHCPEnabled", *dhcpEnabled, asyncResp); 1121 } 1122 1123 if (useDNSServers) 1124 { 1125 BMCWEB_LOG_DEBUG << "set DNSEnabled..."; 1126 setDHCPv4Config("DNSEnabled", *useDNSServers, asyncResp); 1127 } 1128 1129 if (useDomainName) 1130 { 1131 BMCWEB_LOG_DEBUG << "set HostNameEnabled..."; 1132 setDHCPv4Config("HostNameEnabled", *useDomainName, asyncResp); 1133 } 1134 1135 if (useNTPServers) 1136 { 1137 BMCWEB_LOG_DEBUG << "set NTPEnabled..."; 1138 setDHCPv4Config("NTPEnabled", *useNTPServers, asyncResp); 1139 } 1140 } 1141 void handleIPv4StaticPatch( 1142 const std::string &ifaceId, nlohmann::json &input, 1143 const boost::container::flat_set<IPv4AddressData> &ipv4StaticData, 1144 const std::shared_ptr<AsyncResp> asyncResp) 1145 { 1146 if (!input.is_array()) 1147 { 1148 messages::propertyValueTypeError(asyncResp->res, input.dump(), 1149 "IPv4StaticAddresses"); 1150 return; 1151 } 1152 1153 int entryIdx = 0; 1154 boost::container::flat_set<IPv4AddressData>::const_iterator thisData = 1155 ipv4StaticData.begin(); 1156 for (nlohmann::json &thisJson : input) 1157 { 1158 std::string pathString = 1159 "IPv4StaticAddresses/" + std::to_string(entryIdx); 1160 1161 if (thisJson.is_null()) 1162 { 1163 if (thisData != ipv4StaticData.end()) 1164 { 1165 deleteIPv4(ifaceId, thisData->id, asyncResp); 1166 thisData++; 1167 } 1168 else 1169 { 1170 messages::propertyValueFormatError( 1171 asyncResp->res, input.dump(), pathString); 1172 return; 1173 // TODO(ratagupt) Not sure about the property where value is 1174 // list and if unable to update one of the 1175 // list value then should we proceed further or 1176 // break there, would ask in the redfish forum 1177 // till then we stop processing the next list item. 1178 } 1179 entryIdx++; 1180 continue; // not an error as per the redfish spec. 1181 } 1182 1183 if (thisJson.empty()) 1184 { 1185 if (thisData != ipv4StaticData.end()) 1186 { 1187 thisData++; 1188 } 1189 else 1190 { 1191 messages::propertyMissing(asyncResp->res, 1192 pathString + "/Address"); 1193 return; 1194 // TODO(ratagupt) Not sure about the property where value is 1195 // list and if unable to update one of the 1196 // list value then should we proceed further or 1197 // break there, would ask in the redfish forum 1198 // till then we stop processing the next list item. 1199 } 1200 entryIdx++; 1201 continue; // not an error as per the redfish spec. 1202 } 1203 1204 std::optional<std::string> address; 1205 std::optional<std::string> subnetMask; 1206 std::optional<std::string> gateway; 1207 1208 if (!json_util::readJson(thisJson, asyncResp->res, "Address", 1209 address, "SubnetMask", subnetMask, 1210 "Gateway", gateway)) 1211 { 1212 return; 1213 } 1214 1215 if (address) 1216 { 1217 if (!ipv4VerifyIpAndGetBitcount(*address)) 1218 { 1219 messages::propertyValueFormatError(asyncResp->res, *address, 1220 pathString + "/Address"); 1221 return; 1222 } 1223 } 1224 1225 uint8_t prefixLength = 0; 1226 if (subnetMask) 1227 { 1228 if (!ipv4VerifyIpAndGetBitcount(*subnetMask, &prefixLength)) 1229 { 1230 messages::propertyValueFormatError( 1231 asyncResp->res, *subnetMask, 1232 pathString + "/SubnetMask"); 1233 return; 1234 } 1235 } 1236 1237 if (gateway) 1238 { 1239 if (!ipv4VerifyIpAndGetBitcount(*gateway)) 1240 { 1241 messages::propertyValueFormatError(asyncResp->res, *gateway, 1242 pathString + "/Gateway"); 1243 return; 1244 } 1245 } 1246 1247 // if IP address exist then modify it. 1248 if (thisData != ipv4StaticData.end()) 1249 { 1250 // Apply changes 1251 if (address) 1252 { 1253 auto callback = 1254 [asyncResp](const boost::system::error_code ec) { 1255 if (ec) 1256 { 1257 messages::internalError(asyncResp->res); 1258 return; 1259 } 1260 }; 1261 1262 crow::connections::systemBus->async_method_call( 1263 std::move(callback), "xyz.openbmc_project.Network", 1264 "/xyz/openbmc_project/network/" + ifaceId + "/ipv4/" + 1265 thisData->id, 1266 "org.freedesktop.DBus.Properties", "Set", 1267 "xyz.openbmc_project.Network.IP", "Address", 1268 std::variant<std::string>(*address)); 1269 } 1270 1271 if (subnetMask) 1272 { 1273 changeIPv4SubnetMaskProperty(ifaceId, entryIdx, 1274 thisData->id, prefixLength, 1275 asyncResp); 1276 } 1277 1278 if (gateway) 1279 { 1280 auto callback = 1281 [asyncResp](const boost::system::error_code ec) { 1282 if (ec) 1283 { 1284 messages::internalError(asyncResp->res); 1285 return; 1286 } 1287 }; 1288 1289 crow::connections::systemBus->async_method_call( 1290 std::move(callback), "xyz.openbmc_project.Network", 1291 "/xyz/openbmc_project/network/" + ifaceId + "/ipv4/" + 1292 thisData->id, 1293 "org.freedesktop.DBus.Properties", "Set", 1294 "xyz.openbmc_project.Network.IP", "Gateway", 1295 std::variant<std::string>(*gateway)); 1296 } 1297 1298 thisData++; 1299 } 1300 else 1301 { 1302 // Create IPv4 with provided data 1303 if (!gateway) 1304 { 1305 messages::propertyMissing(asyncResp->res, 1306 pathString + "/Gateway"); 1307 continue; 1308 } 1309 1310 if (!address) 1311 { 1312 messages::propertyMissing(asyncResp->res, 1313 pathString + "/Address"); 1314 continue; 1315 } 1316 1317 if (!subnetMask) 1318 { 1319 messages::propertyMissing(asyncResp->res, 1320 pathString + "/SubnetMask"); 1321 continue; 1322 } 1323 1324 createIPv4(ifaceId, entryIdx, prefixLength, *gateway, *address, 1325 asyncResp); 1326 1327 nlohmann::json &ipv4StaticAddressJson = 1328 asyncResp->res.jsonValue["IPv4StaticAddresses"][entryIdx]; 1329 ipv4StaticAddressJson["Address"] = *address; 1330 ipv4StaticAddressJson["SubnetMask"] = *subnetMask; 1331 ipv4StaticAddressJson["Gateway"] = *gateway; 1332 } 1333 entryIdx++; 1334 } 1335 } 1336 1337 void handleStaticNameServersPatch( 1338 const std::string &ifaceId, 1339 const std::vector<std::string> &updatedStaticNameServers, 1340 const std::shared_ptr<AsyncResp> &asyncResp) 1341 { 1342 crow::connections::systemBus->async_method_call( 1343 [asyncResp](const boost::system::error_code ec) { 1344 if (ec) 1345 { 1346 messages::internalError(asyncResp->res); 1347 return; 1348 } 1349 }, 1350 "xyz.openbmc_project.Network", 1351 "/xyz/openbmc_project/network/" + ifaceId, 1352 "org.freedesktop.DBus.Properties", "Set", 1353 "xyz.openbmc_project.Network.EthernetInterface", "Nameservers", 1354 std::variant<std::vector<std::string>>{updatedStaticNameServers}); 1355 } 1356 1357 void handleIPv6StaticAddressesPatch( 1358 const std::string &ifaceId, nlohmann::json &input, 1359 const boost::container::flat_set<IPv6AddressData> &ipv6StaticData, 1360 const std::shared_ptr<AsyncResp> asyncResp) 1361 { 1362 if (!input.is_array()) 1363 { 1364 messages::propertyValueTypeError(asyncResp->res, input.dump(), 1365 "IPv6StaticAddresses"); 1366 return; 1367 } 1368 1369 int entryIdx = 0; 1370 boost::container::flat_set<IPv6AddressData>::const_iterator thisData = 1371 ipv6StaticData.begin(); 1372 for (nlohmann::json &thisJson : input) 1373 { 1374 std::string pathString = 1375 "IPv6StaticAddresses/" + std::to_string(entryIdx); 1376 1377 if (thisJson.is_null()) 1378 { 1379 if (thisData != ipv6StaticData.end()) 1380 { 1381 deleteIPv6(ifaceId, thisData->id, asyncResp); 1382 thisData++; 1383 } 1384 else 1385 { 1386 messages::propertyValueFormatError( 1387 asyncResp->res, input.dump(), pathString); 1388 return; 1389 } 1390 entryIdx++; 1391 continue; 1392 } 1393 1394 if (thisJson.empty()) 1395 { 1396 if (thisData != ipv6StaticData.end()) 1397 { 1398 thisData++; 1399 } 1400 else 1401 { 1402 messages::propertyMissing(asyncResp->res, 1403 pathString + "/Address"); 1404 return; 1405 } 1406 entryIdx++; 1407 continue; 1408 } 1409 1410 std::optional<std::string> address; 1411 std::optional<uint8_t> prefixLength; 1412 1413 if (!json_util::readJson(thisJson, asyncResp->res, "Address", 1414 address, "PrefixLength", prefixLength)) 1415 { 1416 return; 1417 } 1418 1419 // if IP address exist then modify it. 1420 if (thisData != ipv6StaticData.end()) 1421 { 1422 // Apply changes 1423 if (address) 1424 { 1425 auto callback = 1426 [asyncResp](const boost::system::error_code ec) { 1427 if (ec) 1428 { 1429 messages::internalError(asyncResp->res); 1430 return; 1431 } 1432 }; 1433 1434 crow::connections::systemBus->async_method_call( 1435 std::move(callback), "xyz.openbmc_project.Network", 1436 "/xyz/openbmc_project/network/" + ifaceId + "/ipv6/" + 1437 thisData->id, 1438 "org.freedesktop.DBus.Properties", "Set", 1439 "xyz.openbmc_project.Network.IP", "Address", 1440 std::variant<std::string>(*address)); 1441 } 1442 1443 if (prefixLength) 1444 { 1445 auto callback = 1446 [asyncResp](const boost::system::error_code ec) { 1447 if (ec) 1448 { 1449 messages::internalError(asyncResp->res); 1450 return; 1451 } 1452 }; 1453 1454 crow::connections::systemBus->async_method_call( 1455 std::move(callback), "xyz.openbmc_project.Network", 1456 "/xyz/openbmc_project/network/" + ifaceId + "/ipv6/" + 1457 thisData->id, 1458 "org.freedesktop.DBus.Properties", "Set", 1459 "xyz.openbmc_project.Network.IP", "PrefixLength", 1460 std::variant<uint8_t>(*prefixLength)); 1461 } 1462 1463 thisData++; 1464 } 1465 else 1466 { 1467 // Create IPv6 with provided data 1468 1469 if (!prefixLength) 1470 { 1471 messages::propertyMissing(asyncResp->res, 1472 pathString + "/PrefixLength"); 1473 continue; 1474 } 1475 1476 if (!address) 1477 { 1478 messages::propertyMissing(asyncResp->res, 1479 pathString + "/Address"); 1480 continue; 1481 } 1482 1483 createIPv6(ifaceId, entryIdx, *prefixLength, *address, 1484 asyncResp); 1485 1486 nlohmann::json &ipv6StaticAddressJson = 1487 asyncResp->res.jsonValue["IPv6StaticAddresses"][entryIdx]; 1488 ipv6StaticAddressJson["Address"] = *address; 1489 ipv6StaticAddressJson["PrefixLength"] = *prefixLength; 1490 } 1491 entryIdx++; 1492 } 1493 } 1494 1495 void parseInterfaceData( 1496 nlohmann::json &json_response, const std::string &iface_id, 1497 const EthernetInterfaceData ðData, 1498 const boost::container::flat_set<IPv4AddressData> &ipv4Data, 1499 const boost::container::flat_set<IPv4AddressData> &ipv4StaticData, 1500 const boost::container::flat_set<IPv6AddressData> &ipv6Data, 1501 const boost::container::flat_set<IPv6AddressData> &ipv6StaticData) 1502 { 1503 json_response["Id"] = iface_id; 1504 json_response["@odata.id"] = 1505 "/redfish/v1/Managers/bmc/EthernetInterfaces/" + iface_id; 1506 json_response["InterfaceEnabled"] = true; 1507 if (ethData.speed == 0) 1508 { 1509 json_response["LinkStatus"] = "NoLink"; 1510 json_response["Status"] = { 1511 {"Health", "OK"}, 1512 {"State", "Disabled"}, 1513 }; 1514 } 1515 else 1516 { 1517 json_response["LinkStatus"] = "LinkUp"; 1518 json_response["Status"] = { 1519 {"Health", "OK"}, 1520 {"State", "Enabled"}, 1521 }; 1522 } 1523 json_response["SpeedMbps"] = ethData.speed; 1524 json_response["MACAddress"] = ethData.mac_address; 1525 json_response["DHCPv4"]["DHCPEnabled"] = ethData.DHCPEnabled; 1526 1527 if (!ethData.hostname.empty()) 1528 { 1529 json_response["HostName"] = ethData.hostname; 1530 if (!ethData.domainnames.empty()) 1531 { 1532 json_response["FQDN"] = 1533 ethData.hostname + "." + ethData.domainnames[0]; 1534 } 1535 } 1536 1537 json_response["VLANs"] = { 1538 {"@odata.id", "/redfish/v1/Managers/bmc/EthernetInterfaces/" + 1539 iface_id + "/VLANs"}}; 1540 1541 json_response["NameServers"] = ethData.nameservers; 1542 json_response["StaticNameServers"] = ethData.nameservers; 1543 1544 nlohmann::json &ipv4_array = json_response["IPv4Addresses"]; 1545 ipv4_array = nlohmann::json::array(); 1546 for (auto &ipv4_config : ipv4Data) 1547 { 1548 1549 std::string gatewayStr = ipv4_config.gateway; 1550 if (gatewayStr.empty()) 1551 { 1552 gatewayStr = "0.0.0.0"; 1553 } 1554 1555 ipv4_array.push_back({{"AddressOrigin", ipv4_config.origin}, 1556 {"SubnetMask", ipv4_config.netmask}, 1557 {"Address", ipv4_config.address}, 1558 {"Gateway", gatewayStr}}); 1559 } 1560 1561 nlohmann::json &ipv4_static_array = 1562 json_response["IPv4StaticAddresses"]; 1563 ipv4_static_array = nlohmann::json::array(); 1564 for (auto &ipv4_static_config : ipv4StaticData) 1565 { 1566 1567 std::string gatewayStr = ipv4_static_config.gateway; 1568 if (gatewayStr.empty()) 1569 { 1570 gatewayStr = "0.0.0.0"; 1571 } 1572 1573 ipv4_static_array.push_back( 1574 {{"SubnetMask", ipv4_static_config.netmask}, 1575 {"Address", ipv4_static_config.address}, 1576 {"Gateway", gatewayStr}}); 1577 } 1578 1579 json_response["IPv6DefaultGateway"] = ethData.ipv6_default_gateway; 1580 1581 nlohmann::json &ipv6_array = json_response["IPv6Addresses"]; 1582 ipv6_array = nlohmann::json::array(); 1583 for (auto &ipv6_config : ipv6Data) 1584 { 1585 ipv6_array.push_back({{"Address", ipv6_config.address}, 1586 {"PrefixLength", ipv6_config.prefixLength}, 1587 {"AddressOrigin", ipv6_config.origin}}); 1588 } 1589 1590 nlohmann::json &ipv6_static_array = 1591 json_response["IPv6StaticAddresses"]; 1592 ipv6_static_array = nlohmann::json::array(); 1593 for (auto &ipv6_static_config : ipv6StaticData) 1594 { 1595 ipv6_static_array.push_back( 1596 {{"Address", ipv6_static_config.address}, 1597 {"PrefixLength", ipv6_static_config.prefixLength}}); 1598 } 1599 } 1600 1601 /** 1602 * Functions triggers appropriate requests on DBus 1603 */ 1604 void doGet(crow::Response &res, const crow::Request &req, 1605 const std::vector<std::string> ¶ms) override 1606 { 1607 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1608 if (params.size() != 1) 1609 { 1610 messages::internalError(asyncResp->res); 1611 return; 1612 } 1613 1614 getEthernetIfaceData( 1615 params[0], 1616 [this, asyncResp, iface_id{std::string(params[0])}]( 1617 const bool &success, const EthernetInterfaceData ðData, 1618 const boost::container::flat_set<IPv4AddressData> &ipv4Data, 1619 const boost::container::flat_set<IPv4AddressData> 1620 &ipv4StaticData, 1621 const boost::container::flat_set<IPv6AddressData> &ipv6Data, 1622 const boost::container::flat_set<IPv6AddressData> 1623 &ipv6StaticData) { 1624 if (!success) 1625 { 1626 // TODO(Pawel)consider distinguish between non existing 1627 // object, and other errors 1628 messages::resourceNotFound(asyncResp->res, 1629 "EthernetInterface", iface_id); 1630 return; 1631 } 1632 1633 // because this has no dependence on the interface at this 1634 // point, it needs to be done after we know the interface 1635 // exists, not before. 1636 getDHCPConfigData(asyncResp); 1637 1638 asyncResp->res.jsonValue["@odata.type"] = 1639 "#EthernetInterface.v1_4_1.EthernetInterface"; 1640 asyncResp->res.jsonValue["@odata.context"] = 1641 "/redfish/v1/$metadata#EthernetInterface.EthernetInterface"; 1642 asyncResp->res.jsonValue["Name"] = "Manager Ethernet Interface"; 1643 asyncResp->res.jsonValue["Description"] = 1644 "Management Network Interface"; 1645 1646 parseInterfaceData(asyncResp->res.jsonValue, iface_id, ethData, 1647 ipv4Data, ipv4StaticData, ipv6Data, 1648 ipv6StaticData); 1649 }); 1650 } 1651 1652 void doPatch(crow::Response &res, const crow::Request &req, 1653 const std::vector<std::string> ¶ms) override 1654 { 1655 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1656 if (params.size() != 1) 1657 { 1658 messages::internalError(asyncResp->res); 1659 return; 1660 } 1661 1662 const std::string &iface_id = params[0]; 1663 1664 std::optional<std::string> hostname; 1665 std::optional<std::string> macAddress; 1666 std::optional<std::string> ipv6DefaultGateway; 1667 std::optional<nlohmann::json> ipv4Addresses; 1668 std::optional<nlohmann::json> ipv4StaticAddresses; 1669 std::optional<nlohmann::json> ipv6Addresses; 1670 std::optional<nlohmann::json> ipv6StaticAddresses; 1671 std::optional<std::vector<std::string>> staticNameServers; 1672 std::optional<std::vector<std::string>> nameServers; 1673 std::optional<nlohmann::json> dhcpv4; 1674 1675 if (!json_util::readJson( 1676 req, res, "HostName", hostname, "IPv4Addresses", ipv4Addresses, 1677 "IPv4StaticAddresses", ipv4StaticAddresses, "MACAddress", 1678 macAddress, "StaticNameServers", staticNameServers, 1679 "IPv6DefaultGateway", ipv6DefaultGateway, "IPv6StaticAddresses", 1680 ipv6StaticAddresses, "NameServers", nameServers, "DHCPv4", 1681 dhcpv4)) 1682 { 1683 return; 1684 } 1685 1686 if (dhcpv4) 1687 { 1688 handleDHCPv4Patch(iface_id, *dhcpv4, asyncResp); 1689 } 1690 1691 // Get single eth interface data, and call the below callback for JSON 1692 // preparation 1693 getEthernetIfaceData( 1694 iface_id, 1695 [this, asyncResp, iface_id, hostname = std::move(hostname), 1696 macAddress = std::move(macAddress), 1697 ipv4Addresses = std::move(ipv4Addresses), 1698 ipv4StaticAddresses = std::move(ipv4StaticAddresses), 1699 ipv6DefaultGateway = std::move(ipv6DefaultGateway), 1700 ipv6StaticAddresses = std::move(ipv6StaticAddresses), 1701 staticNameServers = std::move(staticNameServers), 1702 nameServers = std::move(nameServers)]( 1703 const bool &success, const EthernetInterfaceData ðData, 1704 const boost::container::flat_set<IPv4AddressData> &ipv4Data, 1705 const boost::container::flat_set<IPv4AddressData> 1706 &ipv4StaticData, 1707 const boost::container::flat_set<IPv6AddressData> &ipv6Data, 1708 const boost::container::flat_set<IPv6AddressData> 1709 &ipv6StaticData) { 1710 if (!success) 1711 { 1712 // ... otherwise return error 1713 // TODO(Pawel)consider distinguish between non existing 1714 // object, and other errors 1715 messages::resourceNotFound(asyncResp->res, 1716 "Ethernet Interface", iface_id); 1717 return; 1718 } 1719 1720 if (hostname) 1721 { 1722 handleHostnamePatch(*hostname, asyncResp); 1723 } 1724 1725 if (macAddress) 1726 { 1727 handleMACAddressPatch(iface_id, *macAddress, asyncResp); 1728 } 1729 1730 if (ipv4Addresses) 1731 { 1732 messages::propertyNotWritable(asyncResp->res, 1733 "IPv4Addresses"); 1734 } 1735 1736 if (ipv4StaticAddresses) 1737 { 1738 // TODO(ed) for some reason the capture of ipv4Addresses 1739 // above is returning a const value, not a non-const value. 1740 // This doesn't really work for us, as we need to be able to 1741 // efficiently move out the intermedia nlohmann::json 1742 // objects. This makes a copy of the structure, and operates 1743 // on that, but could be done more efficiently 1744 nlohmann::json ipv4Static = std::move(*ipv4StaticAddresses); 1745 handleIPv4StaticPatch(iface_id, ipv4Static, ipv4StaticData, 1746 asyncResp); 1747 } 1748 1749 if (nameServers) 1750 { 1751 // Data.Permissions is read-only 1752 messages::propertyNotWritable(asyncResp->res, 1753 "NameServers"); 1754 } 1755 1756 if (staticNameServers) 1757 { 1758 handleStaticNameServersPatch(iface_id, *staticNameServers, 1759 asyncResp); 1760 } 1761 1762 if (ipv6DefaultGateway) 1763 { 1764 messages::propertyNotWritable(asyncResp->res, 1765 "IPv6DefaultGateway"); 1766 } 1767 1768 if (ipv6StaticAddresses) 1769 { 1770 nlohmann::json ipv6Static = std::move(*ipv6StaticAddresses); 1771 handleIPv6StaticAddressesPatch(iface_id, ipv6Static, 1772 ipv6StaticData, asyncResp); 1773 } 1774 }); 1775 } 1776 }; 1777 1778 /** 1779 * VlanNetworkInterface derived class for delivering VLANNetworkInterface 1780 * Schema 1781 */ 1782 class VlanNetworkInterface : public Node 1783 { 1784 public: 1785 /* 1786 * Default Constructor 1787 */ 1788 template <typename CrowApp> 1789 VlanNetworkInterface(CrowApp &app) : 1790 Node(app, 1791 "/redfish/v1/Managers/bmc/EthernetInterfaces/<str>/VLANs/<str>", 1792 std::string(), std::string()) 1793 { 1794 entityPrivileges = { 1795 {boost::beast::http::verb::get, {{"Login"}}}, 1796 {boost::beast::http::verb::head, {{"Login"}}}, 1797 {boost::beast::http::verb::patch, {{"ConfigureComponents"}}}, 1798 {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, 1799 {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, 1800 {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; 1801 } 1802 1803 private: 1804 void parseInterfaceData( 1805 nlohmann::json &json_response, const std::string &parent_iface_id, 1806 const std::string &iface_id, const EthernetInterfaceData ðData, 1807 const boost::container::flat_set<IPv4AddressData> &ipv4Data, 1808 const boost::container::flat_set<IPv4AddressData> &ipv4StaticData, 1809 const boost::container::flat_set<IPv6AddressData> &ipv6Data, 1810 const boost::container::flat_set<IPv6AddressData> &ipv6StaticData) 1811 { 1812 // Fill out obvious data... 1813 json_response["Id"] = iface_id; 1814 json_response["@odata.id"] = 1815 "/redfish/v1/Managers/bmc/EthernetInterfaces/" + parent_iface_id + 1816 "/VLANs/" + iface_id; 1817 1818 json_response["VLANEnable"] = true; 1819 if (!ethData.vlan_id.empty()) 1820 { 1821 json_response["VLANId"] = ethData.vlan_id.back(); 1822 } 1823 } 1824 1825 bool verifyNames(const std::string &parent, const std::string &iface) 1826 { 1827 if (!boost::starts_with(iface, parent + "_")) 1828 { 1829 return false; 1830 } 1831 else 1832 { 1833 return true; 1834 } 1835 } 1836 1837 /** 1838 * Functions triggers appropriate requests on DBus 1839 */ 1840 void doGet(crow::Response &res, const crow::Request &req, 1841 const std::vector<std::string> ¶ms) override 1842 { 1843 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1844 // TODO(Pawel) this shall be parameterized call (two params) to get 1845 // EthernetInterfaces for any Manager, not only hardcoded 'openbmc'. 1846 // Check if there is required param, truly entering this shall be 1847 // impossible. 1848 if (params.size() != 2) 1849 { 1850 messages::internalError(res); 1851 res.end(); 1852 return; 1853 } 1854 1855 const std::string &parent_iface_id = params[0]; 1856 const std::string &iface_id = params[1]; 1857 res.jsonValue["@odata.type"] = 1858 "#VLanNetworkInterface.v1_1_0.VLanNetworkInterface"; 1859 res.jsonValue["@odata.context"] = 1860 "/redfish/v1/$metadata#VLanNetworkInterface.VLanNetworkInterface"; 1861 res.jsonValue["Name"] = "VLAN Network Interface"; 1862 1863 if (!verifyNames(parent_iface_id, iface_id)) 1864 { 1865 return; 1866 } 1867 1868 // Get single eth interface data, and call the below callback for JSON 1869 // preparation 1870 getEthernetIfaceData( 1871 params[1], 1872 [this, asyncResp, parent_iface_id{std::string(params[0])}, 1873 iface_id{std::string(params[1])}]( 1874 const bool &success, const EthernetInterfaceData ðData, 1875 const boost::container::flat_set<IPv4AddressData> &ipv4Data, 1876 const boost::container::flat_set<IPv4AddressData> 1877 &ipv4StaticData, 1878 const boost::container::flat_set<IPv6AddressData> &ipv6Data, 1879 const boost::container::flat_set<IPv6AddressData> 1880 &ipv6StaticData) { 1881 if (success && ethData.vlan_id.size() != 0) 1882 { 1883 parseInterfaceData(asyncResp->res.jsonValue, 1884 parent_iface_id, iface_id, ethData, 1885 ipv4Data, ipv4StaticData, ipv6Data, 1886 ipv6StaticData); 1887 } 1888 else 1889 { 1890 // ... otherwise return error 1891 // TODO(Pawel)consider distinguish between non existing 1892 // object, and other errors 1893 messages::resourceNotFound( 1894 asyncResp->res, "VLAN Network Interface", iface_id); 1895 } 1896 }); 1897 } 1898 1899 void doPatch(crow::Response &res, const crow::Request &req, 1900 const std::vector<std::string> ¶ms) override 1901 { 1902 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1903 if (params.size() != 2) 1904 { 1905 messages::internalError(asyncResp->res); 1906 return; 1907 } 1908 1909 const std::string &parentIfaceId = params[0]; 1910 const std::string &ifaceId = params[1]; 1911 1912 if (!verifyNames(parentIfaceId, ifaceId)) 1913 { 1914 messages::resourceNotFound(asyncResp->res, "VLAN Network Interface", 1915 ifaceId); 1916 return; 1917 } 1918 1919 bool vlanEnable = false; 1920 uint64_t vlanId = 0; 1921 1922 if (!json_util::readJson(req, res, "VLANEnable", vlanEnable, "VLANId", 1923 vlanId)) 1924 { 1925 return; 1926 } 1927 1928 // Get single eth interface data, and call the below callback for JSON 1929 // preparation 1930 getEthernetIfaceData( 1931 params[1], 1932 [this, asyncResp, parentIfaceId{std::string(params[0])}, 1933 ifaceId{std::string(params[1])}, &vlanEnable, &vlanId]( 1934 const bool &success, const EthernetInterfaceData ðData, 1935 const boost::container::flat_set<IPv4AddressData> &ipv4Data, 1936 const boost::container::flat_set<IPv4AddressData> 1937 &ipv4StaticData, 1938 const boost::container::flat_set<IPv6AddressData> &ipv6Data, 1939 const boost::container::flat_set<IPv6AddressData> 1940 &ipv6StaticData) { 1941 if (success && !ethData.vlan_id.empty()) 1942 { 1943 auto callback = 1944 [asyncResp](const boost::system::error_code ec) { 1945 if (ec) 1946 { 1947 messages::internalError(asyncResp->res); 1948 } 1949 }; 1950 1951 if (vlanEnable == true) 1952 { 1953 crow::connections::systemBus->async_method_call( 1954 std::move(callback), "xyz.openbmc_project.Network", 1955 "/xyz/openbmc_project/network/" + ifaceId, 1956 "org.freedesktop.DBus.Properties", "Set", 1957 "xyz.openbmc_project.Network.VLAN", "Id", 1958 std::variant<uint32_t>(vlanId)); 1959 } 1960 else 1961 { 1962 BMCWEB_LOG_DEBUG << "vlanEnable is false. Deleting the " 1963 "vlan interface"; 1964 crow::connections::systemBus->async_method_call( 1965 std::move(callback), "xyz.openbmc_project.Network", 1966 std::string("/xyz/openbmc_project/network/") + 1967 ifaceId, 1968 "xyz.openbmc_project.Object.Delete", "Delete"); 1969 } 1970 } 1971 else 1972 { 1973 // TODO(Pawel)consider distinguish between non existing 1974 // object, and other errors 1975 messages::resourceNotFound( 1976 asyncResp->res, "VLAN Network Interface", ifaceId); 1977 return; 1978 } 1979 }); 1980 } 1981 1982 void doDelete(crow::Response &res, const crow::Request &req, 1983 const std::vector<std::string> ¶ms) override 1984 { 1985 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1986 if (params.size() != 2) 1987 { 1988 messages::internalError(asyncResp->res); 1989 return; 1990 } 1991 1992 const std::string &parentIfaceId = params[0]; 1993 const std::string &ifaceId = params[1]; 1994 1995 if (!verifyNames(parentIfaceId, ifaceId)) 1996 { 1997 messages::resourceNotFound(asyncResp->res, "VLAN Network Interface", 1998 ifaceId); 1999 return; 2000 } 2001 2002 // Get single eth interface data, and call the below callback for JSON 2003 // preparation 2004 getEthernetIfaceData( 2005 params[1], 2006 [this, asyncResp, parentIfaceId{std::string(params[0])}, 2007 ifaceId{std::string(params[1])}]( 2008 const bool &success, const EthernetInterfaceData ðData, 2009 const boost::container::flat_set<IPv4AddressData> &ipv4Data, 2010 const boost::container::flat_set<IPv4AddressData> 2011 &ipv4StaticData, 2012 const boost::container::flat_set<IPv6AddressData> &ipv6Data, 2013 const boost::container::flat_set<IPv6AddressData> 2014 &ipv6StaticData) { 2015 if (success && !ethData.vlan_id.empty()) 2016 { 2017 auto callback = 2018 [asyncResp](const boost::system::error_code ec) { 2019 if (ec) 2020 { 2021 messages::internalError(asyncResp->res); 2022 } 2023 }; 2024 crow::connections::systemBus->async_method_call( 2025 std::move(callback), "xyz.openbmc_project.Network", 2026 std::string("/xyz/openbmc_project/network/") + ifaceId, 2027 "xyz.openbmc_project.Object.Delete", "Delete"); 2028 } 2029 else 2030 { 2031 // ... otherwise return error 2032 // TODO(Pawel)consider distinguish between non existing 2033 // object, and other errors 2034 messages::resourceNotFound( 2035 asyncResp->res, "VLAN Network Interface", ifaceId); 2036 } 2037 }); 2038 } 2039 }; 2040 2041 /** 2042 * VlanNetworkInterfaceCollection derived class for delivering 2043 * VLANNetworkInterface Collection Schema 2044 */ 2045 class VlanNetworkInterfaceCollection : public Node 2046 { 2047 public: 2048 template <typename CrowApp> 2049 VlanNetworkInterfaceCollection(CrowApp &app) : 2050 Node(app, "/redfish/v1/Managers/bmc/EthernetInterfaces/<str>/VLANs/", 2051 std::string()) 2052 { 2053 entityPrivileges = { 2054 {boost::beast::http::verb::get, {{"Login"}}}, 2055 {boost::beast::http::verb::head, {{"Login"}}}, 2056 {boost::beast::http::verb::patch, {{"ConfigureComponents"}}}, 2057 {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, 2058 {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, 2059 {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; 2060 } 2061 2062 private: 2063 /** 2064 * Functions triggers appropriate requests on DBus 2065 */ 2066 void doGet(crow::Response &res, const crow::Request &req, 2067 const std::vector<std::string> ¶ms) override 2068 { 2069 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 2070 if (params.size() != 1) 2071 { 2072 // This means there is a problem with the router 2073 messages::internalError(asyncResp->res); 2074 return; 2075 } 2076 2077 const std::string &rootInterfaceName = params[0]; 2078 2079 // Get eth interface list, and call the below callback for JSON 2080 // preparation 2081 getEthernetIfaceList( 2082 [asyncResp, rootInterfaceName{std::string(rootInterfaceName)}]( 2083 const bool &success, 2084 const boost::container::flat_set<std::string> &iface_list) { 2085 if (!success) 2086 { 2087 messages::internalError(asyncResp->res); 2088 return; 2089 } 2090 2091 if (iface_list.find(rootInterfaceName) == iface_list.end()) 2092 { 2093 messages::resourceNotFound(asyncResp->res, 2094 "VLanNetworkInterfaceCollection", 2095 rootInterfaceName); 2096 return; 2097 } 2098 2099 asyncResp->res.jsonValue["@odata.type"] = 2100 "#VLanNetworkInterfaceCollection." 2101 "VLanNetworkInterfaceCollection"; 2102 asyncResp->res.jsonValue["@odata.context"] = 2103 "/redfish/v1/$metadata" 2104 "#VLanNetworkInterfaceCollection." 2105 "VLanNetworkInterfaceCollection"; 2106 asyncResp->res.jsonValue["Name"] = 2107 "VLAN Network Interface Collection"; 2108 2109 nlohmann::json iface_array = nlohmann::json::array(); 2110 2111 for (const std::string &iface_item : iface_list) 2112 { 2113 if (boost::starts_with(iface_item, rootInterfaceName + "_")) 2114 { 2115 iface_array.push_back( 2116 {{"@odata.id", 2117 "/redfish/v1/Managers/bmc/EthernetInterfaces/" + 2118 rootInterfaceName + "/VLANs/" + iface_item}}); 2119 } 2120 } 2121 2122 asyncResp->res.jsonValue["Members@odata.count"] = 2123 iface_array.size(); 2124 asyncResp->res.jsonValue["Members"] = std::move(iface_array); 2125 asyncResp->res.jsonValue["@odata.id"] = 2126 "/redfish/v1/Managers/bmc/EthernetInterfaces/" + 2127 rootInterfaceName + "/VLANs"; 2128 }); 2129 } 2130 2131 void doPost(crow::Response &res, const crow::Request &req, 2132 const std::vector<std::string> ¶ms) override 2133 { 2134 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 2135 if (params.size() != 1) 2136 { 2137 messages::internalError(asyncResp->res); 2138 return; 2139 } 2140 bool vlanEnable = false; 2141 uint32_t vlanId = 0; 2142 if (!json_util::readJson(req, res, "VLANId", vlanId, "VLANEnable", 2143 vlanEnable)) 2144 { 2145 return; 2146 } 2147 // Need both vlanId and vlanEnable to service this request 2148 if (!vlanId) 2149 { 2150 messages::propertyMissing(asyncResp->res, "VLANId"); 2151 } 2152 if (!vlanEnable) 2153 { 2154 messages::propertyMissing(asyncResp->res, "VLANEnable"); 2155 } 2156 if (static_cast<bool>(vlanId) ^ static_cast<bool>(vlanEnable)) 2157 { 2158 return; 2159 } 2160 2161 const std::string &rootInterfaceName = params[0]; 2162 auto callback = [asyncResp](const boost::system::error_code ec) { 2163 if (ec) 2164 { 2165 // TODO(ed) make more consistent error messages based on 2166 // phosphor-network responses 2167 messages::internalError(asyncResp->res); 2168 return; 2169 } 2170 messages::created(asyncResp->res); 2171 }; 2172 crow::connections::systemBus->async_method_call( 2173 std::move(callback), "xyz.openbmc_project.Network", 2174 "/xyz/openbmc_project/network", 2175 "xyz.openbmc_project.Network.VLAN.Create", "VLAN", 2176 rootInterfaceName, vlanId); 2177 } 2178 }; 2179 } // namespace redfish 2180