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 { 861 ipv4.gateway = ethData.default_gateway; 862 } 863 } 864 865 extractIPV6Data(ethiface_id, resp, ipv6Data, ipv6StaticData); 866 // Finally make a callback with usefull data 867 callback(true, ethData, ipv4Data, ipv4StaticData, ipv6Data, 868 ipv6StaticData); 869 }, 870 "xyz.openbmc_project.Network", "/xyz/openbmc_project/network", 871 "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 872 }; 873 874 /** 875 * Function that retrieves all Ethernet Interfaces available through Network 876 * Manager 877 * @param callback a function that shall be called to convert Dbus output 878 * into JSON. 879 */ 880 template <typename CallbackFunc> 881 void getEthernetIfaceList(CallbackFunc &&callback) 882 { 883 crow::connections::systemBus->async_method_call( 884 [callback{std::move(callback)}]( 885 const boost::system::error_code error_code, 886 GetManagedObjects &resp) { 887 // Callback requires vector<string> to retrieve all available 888 // ethernet interfaces 889 boost::container::flat_set<std::string> iface_list; 890 iface_list.reserve(resp.size()); 891 if (error_code) 892 { 893 callback(false, iface_list); 894 return; 895 } 896 897 // Iterate over all retrieved ObjectPaths. 898 for (const auto &objpath : resp) 899 { 900 // And all interfaces available for certain ObjectPath. 901 for (const auto &interface : objpath.second) 902 { 903 // If interface is 904 // xyz.openbmc_project.Network.EthernetInterface, this is 905 // what we're looking for. 906 if (interface.first == 907 "xyz.openbmc_project.Network.EthernetInterface") 908 { 909 // Cut out everyting until last "/", ... 910 const std::string &iface_id = objpath.first.str; 911 std::size_t last_pos = iface_id.rfind("/"); 912 if (last_pos != std::string::npos) 913 { 914 // and put it into output vector. 915 iface_list.emplace(iface_id.substr(last_pos + 1)); 916 } 917 } 918 } 919 } 920 // Finally make a callback with useful data 921 callback(true, iface_list); 922 }, 923 "xyz.openbmc_project.Network", "/xyz/openbmc_project/network", 924 "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 925 }; 926 927 /** 928 * EthernetCollection derived class for delivering Ethernet Collection Schema 929 */ 930 class EthernetCollection : public Node 931 { 932 public: 933 template <typename CrowApp> 934 EthernetCollection(CrowApp &app) : 935 Node(app, "/redfish/v1/Managers/bmc/EthernetInterfaces/") 936 { 937 entityPrivileges = { 938 {boost::beast::http::verb::get, {{"Login"}}}, 939 {boost::beast::http::verb::head, {{"Login"}}}, 940 {boost::beast::http::verb::patch, {{"ConfigureComponents"}}}, 941 {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, 942 {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, 943 {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; 944 } 945 946 private: 947 /** 948 * Functions triggers appropriate requests on DBus 949 */ 950 void doGet(crow::Response &res, const crow::Request &req, 951 const std::vector<std::string> ¶ms) override 952 { 953 res.jsonValue["@odata.type"] = 954 "#EthernetInterfaceCollection.EthernetInterfaceCollection"; 955 res.jsonValue["@odata.context"] = 956 "/redfish/v1/" 957 "$metadata#EthernetInterfaceCollection.EthernetInterfaceCollection"; 958 res.jsonValue["@odata.id"] = 959 "/redfish/v1/Managers/bmc/EthernetInterfaces"; 960 res.jsonValue["Name"] = "Ethernet Network Interface Collection"; 961 res.jsonValue["Description"] = 962 "Collection of EthernetInterfaces for this Manager"; 963 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 964 // Get eth interface list, and call the below callback for JSON 965 // preparation 966 getEthernetIfaceList( 967 [asyncResp]( 968 const bool &success, 969 const boost::container::flat_set<std::string> &iface_list) { 970 if (!success) 971 { 972 messages::internalError(asyncResp->res); 973 return; 974 } 975 976 nlohmann::json &iface_array = 977 asyncResp->res.jsonValue["Members"]; 978 iface_array = nlohmann::json::array(); 979 std::string tag = "_"; 980 for (const std::string &iface_item : iface_list) 981 { 982 std::size_t found = iface_item.find(tag); 983 if (found == std::string::npos) 984 { 985 iface_array.push_back( 986 {{"@odata.id", 987 "/redfish/v1/Managers/bmc/EthernetInterfaces/" + 988 iface_item}}); 989 } 990 } 991 992 asyncResp->res.jsonValue["Members@odata.count"] = 993 iface_array.size(); 994 asyncResp->res.jsonValue["@odata.id"] = 995 "/redfish/v1/Managers/bmc/EthernetInterfaces"; 996 }); 997 } 998 }; 999 1000 /** 1001 * EthernetInterface derived class for delivering Ethernet Schema 1002 */ 1003 class EthernetInterface : public Node 1004 { 1005 public: 1006 /* 1007 * Default Constructor 1008 */ 1009 template <typename CrowApp> 1010 EthernetInterface(CrowApp &app) : 1011 Node(app, "/redfish/v1/Managers/bmc/EthernetInterfaces/<str>/", 1012 std::string()) 1013 { 1014 entityPrivileges = { 1015 {boost::beast::http::verb::get, {{"Login"}}}, 1016 {boost::beast::http::verb::head, {{"Login"}}}, 1017 {boost::beast::http::verb::patch, {{"ConfigureComponents"}}}, 1018 {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, 1019 {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, 1020 {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; 1021 } 1022 1023 private: 1024 void handleHostnamePatch(const std::string &hostname, 1025 const std::shared_ptr<AsyncResp> asyncResp) 1026 { 1027 asyncResp->res.jsonValue["HostName"] = hostname; 1028 crow::connections::systemBus->async_method_call( 1029 [asyncResp](const boost::system::error_code ec) { 1030 if (ec) 1031 { 1032 messages::internalError(asyncResp->res); 1033 } 1034 }, 1035 "xyz.openbmc_project.Network", 1036 "/xyz/openbmc_project/network/config", 1037 "org.freedesktop.DBus.Properties", "Set", 1038 "xyz.openbmc_project.Network.SystemConfiguration", "HostName", 1039 std::variant<std::string>(hostname)); 1040 } 1041 1042 void handleMACAddressPatch(const std::string &ifaceId, 1043 const std::string &macAddress, 1044 const std::shared_ptr<AsyncResp> &asyncResp) 1045 { 1046 crow::connections::systemBus->async_method_call( 1047 [asyncResp, macAddress](const boost::system::error_code ec) { 1048 if (ec) 1049 { 1050 messages::internalError(asyncResp->res); 1051 return; 1052 } 1053 }, 1054 "xyz.openbmc_project.Network", 1055 "/xyz/openbmc_project/network/" + ifaceId, 1056 "org.freedesktop.DBus.Properties", "Set", 1057 "xyz.openbmc_project.Network.MACAddress", "MACAddress", 1058 std::variant<std::string>(macAddress)); 1059 } 1060 1061 void setDHCPEnabled(const std::string &ifaceId, 1062 const std::string &propertyName, const bool &value, 1063 const std::shared_ptr<AsyncResp> asyncResp) 1064 { 1065 crow::connections::systemBus->async_method_call( 1066 [asyncResp](const boost::system::error_code ec) { 1067 if (ec) 1068 { 1069 BMCWEB_LOG_ERROR << "D-Bus responses error: " << ec; 1070 messages::internalError(asyncResp->res); 1071 return; 1072 } 1073 }, 1074 "xyz.openbmc_project.Network", 1075 "/xyz/openbmc_project/network/" + ifaceId, 1076 "org.freedesktop.DBus.Properties", "Set", 1077 "xyz.openbmc_project.Network.EthernetInterface", propertyName, 1078 std::variant<bool>{value}); 1079 } 1080 void setDHCPv4Config(const std::string &propertyName, const bool &value, 1081 const std::shared_ptr<AsyncResp> asyncResp) 1082 { 1083 BMCWEB_LOG_DEBUG << propertyName << " = " << value; 1084 crow::connections::systemBus->async_method_call( 1085 [asyncResp](const boost::system::error_code ec) { 1086 if (ec) 1087 { 1088 BMCWEB_LOG_ERROR << "D-Bus responses error: " << ec; 1089 messages::internalError(asyncResp->res); 1090 return; 1091 } 1092 }, 1093 "xyz.openbmc_project.Network", 1094 "/xyz/openbmc_project/network/config/dhcp", 1095 "org.freedesktop.DBus.Properties", "Set", 1096 "xyz.openbmc_project.Network.DHCPConfiguration", propertyName, 1097 std::variant<bool>{value}); 1098 } 1099 1100 void handleDHCPv4Patch(const std::string &ifaceId, nlohmann::json &input, 1101 const std::shared_ptr<AsyncResp> asyncResp) 1102 { 1103 std::optional<bool> dhcpEnabled; 1104 std::optional<bool> useDNSServers; 1105 std::optional<bool> useDomainName; 1106 std::optional<bool> useNTPServers; 1107 1108 if (!json_util::readJson(input, asyncResp->res, "DHCPEnabled", 1109 dhcpEnabled, "UseDNSServers", useDNSServers, 1110 "UseDomainName", useDomainName, 1111 "UseNTPServers", useNTPServers)) 1112 { 1113 return; 1114 } 1115 1116 if (dhcpEnabled) 1117 { 1118 BMCWEB_LOG_DEBUG << "set DHCPEnabled..."; 1119 setDHCPEnabled(ifaceId, "DHCPEnabled", *dhcpEnabled, asyncResp); 1120 } 1121 1122 if (useDNSServers) 1123 { 1124 BMCWEB_LOG_DEBUG << "set DNSEnabled..."; 1125 setDHCPv4Config("DNSEnabled", *useDNSServers, asyncResp); 1126 } 1127 1128 if (useDomainName) 1129 { 1130 BMCWEB_LOG_DEBUG << "set HostNameEnabled..."; 1131 setDHCPv4Config("HostNameEnabled", *useDomainName, asyncResp); 1132 } 1133 1134 if (useNTPServers) 1135 { 1136 BMCWEB_LOG_DEBUG << "set NTPEnabled..."; 1137 setDHCPv4Config("NTPEnabled", *useNTPServers, asyncResp); 1138 } 1139 } 1140 void handleIPv4StaticPatch( 1141 const std::string &ifaceId, nlohmann::json &input, 1142 const boost::container::flat_set<IPv4AddressData> &ipv4StaticData, 1143 const std::shared_ptr<AsyncResp> asyncResp) 1144 { 1145 if (!input.is_array()) 1146 { 1147 messages::propertyValueTypeError(asyncResp->res, input.dump(), 1148 "IPv4StaticAddresses"); 1149 return; 1150 } 1151 1152 int entryIdx = 0; 1153 boost::container::flat_set<IPv4AddressData>::const_iterator thisData = 1154 ipv4StaticData.begin(); 1155 for (nlohmann::json &thisJson : input) 1156 { 1157 std::string pathString = 1158 "IPv4StaticAddresses/" + std::to_string(entryIdx); 1159 1160 if (thisJson.is_null()) 1161 { 1162 if (thisData != ipv4StaticData.end()) 1163 { 1164 deleteIPv4(ifaceId, thisData->id, asyncResp); 1165 thisData++; 1166 } 1167 else 1168 { 1169 messages::propertyValueFormatError( 1170 asyncResp->res, input.dump(), pathString); 1171 return; 1172 // TODO(ratagupt) Not sure about the property where value is 1173 // list and if unable to update one of the 1174 // list value then should we proceed further or 1175 // break there, would ask in the redfish forum 1176 // till then we stop processing the next list item. 1177 } 1178 entryIdx++; 1179 continue; // not an error as per the redfish spec. 1180 } 1181 1182 if (thisJson.empty()) 1183 { 1184 if (thisData != ipv4StaticData.end()) 1185 { 1186 thisData++; 1187 } 1188 else 1189 { 1190 messages::propertyMissing(asyncResp->res, 1191 pathString + "/Address"); 1192 return; 1193 // TODO(ratagupt) Not sure about the property where value is 1194 // list and if unable to update one of the 1195 // list value then should we proceed further or 1196 // break there, would ask in the redfish forum 1197 // till then we stop processing the next list item. 1198 } 1199 entryIdx++; 1200 continue; // not an error as per the redfish spec. 1201 } 1202 1203 std::optional<std::string> address; 1204 std::optional<std::string> subnetMask; 1205 std::optional<std::string> gateway; 1206 1207 if (!json_util::readJson(thisJson, asyncResp->res, "Address", 1208 address, "SubnetMask", subnetMask, 1209 "Gateway", gateway)) 1210 { 1211 return; 1212 } 1213 1214 if (address) 1215 { 1216 if (!ipv4VerifyIpAndGetBitcount(*address)) 1217 { 1218 messages::propertyValueFormatError(asyncResp->res, *address, 1219 pathString + "/Address"); 1220 return; 1221 } 1222 } 1223 1224 uint8_t prefixLength = 0; 1225 if (subnetMask) 1226 { 1227 if (!ipv4VerifyIpAndGetBitcount(*subnetMask, &prefixLength)) 1228 { 1229 messages::propertyValueFormatError( 1230 asyncResp->res, *subnetMask, 1231 pathString + "/SubnetMask"); 1232 return; 1233 } 1234 } 1235 1236 if (gateway) 1237 { 1238 if (!ipv4VerifyIpAndGetBitcount(*gateway)) 1239 { 1240 messages::propertyValueFormatError(asyncResp->res, *gateway, 1241 pathString + "/Gateway"); 1242 return; 1243 } 1244 } 1245 1246 // if IP address exist then modify it. 1247 if (thisData != ipv4StaticData.end()) 1248 { 1249 // Apply changes 1250 if (address) 1251 { 1252 auto callback = 1253 [asyncResp](const boost::system::error_code ec) { 1254 if (ec) 1255 { 1256 messages::internalError(asyncResp->res); 1257 return; 1258 } 1259 }; 1260 1261 crow::connections::systemBus->async_method_call( 1262 std::move(callback), "xyz.openbmc_project.Network", 1263 "/xyz/openbmc_project/network/" + ifaceId + "/ipv4/" + 1264 thisData->id, 1265 "org.freedesktop.DBus.Properties", "Set", 1266 "xyz.openbmc_project.Network.IP", "Address", 1267 std::variant<std::string>(*address)); 1268 } 1269 1270 if (subnetMask) 1271 { 1272 changeIPv4SubnetMaskProperty(ifaceId, entryIdx, 1273 thisData->id, prefixLength, 1274 asyncResp); 1275 } 1276 1277 if (gateway) 1278 { 1279 auto callback = 1280 [asyncResp](const boost::system::error_code ec) { 1281 if (ec) 1282 { 1283 messages::internalError(asyncResp->res); 1284 return; 1285 } 1286 }; 1287 1288 crow::connections::systemBus->async_method_call( 1289 std::move(callback), "xyz.openbmc_project.Network", 1290 "/xyz/openbmc_project/network/" + ifaceId + "/ipv4/" + 1291 thisData->id, 1292 "org.freedesktop.DBus.Properties", "Set", 1293 "xyz.openbmc_project.Network.IP", "Gateway", 1294 std::variant<std::string>(*gateway)); 1295 } 1296 1297 thisData++; 1298 } 1299 else 1300 { 1301 // Create IPv4 with provided data 1302 if (!gateway) 1303 { 1304 messages::propertyMissing(asyncResp->res, 1305 pathString + "/Gateway"); 1306 continue; 1307 } 1308 1309 if (!address) 1310 { 1311 messages::propertyMissing(asyncResp->res, 1312 pathString + "/Address"); 1313 continue; 1314 } 1315 1316 if (!subnetMask) 1317 { 1318 messages::propertyMissing(asyncResp->res, 1319 pathString + "/SubnetMask"); 1320 continue; 1321 } 1322 1323 createIPv4(ifaceId, entryIdx, prefixLength, *gateway, *address, 1324 asyncResp); 1325 1326 nlohmann::json &ipv4StaticAddressJson = 1327 asyncResp->res.jsonValue["IPv4StaticAddresses"][entryIdx]; 1328 ipv4StaticAddressJson["Address"] = *address; 1329 ipv4StaticAddressJson["SubnetMask"] = *subnetMask; 1330 ipv4StaticAddressJson["Gateway"] = *gateway; 1331 } 1332 entryIdx++; 1333 } 1334 } 1335 1336 void handleStaticNameServersPatch( 1337 const std::string &ifaceId, 1338 const std::vector<std::string> &updatedStaticNameServers, 1339 const std::shared_ptr<AsyncResp> &asyncResp) 1340 { 1341 crow::connections::systemBus->async_method_call( 1342 [asyncResp](const boost::system::error_code ec) { 1343 if (ec) 1344 { 1345 messages::internalError(asyncResp->res); 1346 return; 1347 } 1348 }, 1349 "xyz.openbmc_project.Network", 1350 "/xyz/openbmc_project/network/" + ifaceId, 1351 "org.freedesktop.DBus.Properties", "Set", 1352 "xyz.openbmc_project.Network.EthernetInterface", "Nameservers", 1353 std::variant<std::vector<std::string>>{updatedStaticNameServers}); 1354 } 1355 1356 void handleIPv6StaticAddressesPatch( 1357 const std::string &ifaceId, nlohmann::json &input, 1358 const boost::container::flat_set<IPv6AddressData> &ipv6StaticData, 1359 const std::shared_ptr<AsyncResp> asyncResp) 1360 { 1361 if (!input.is_array()) 1362 { 1363 messages::propertyValueTypeError(asyncResp->res, input.dump(), 1364 "IPv6StaticAddresses"); 1365 return; 1366 } 1367 1368 int entryIdx = 0; 1369 boost::container::flat_set<IPv6AddressData>::const_iterator thisData = 1370 ipv6StaticData.begin(); 1371 for (nlohmann::json &thisJson : input) 1372 { 1373 std::string pathString = 1374 "IPv6StaticAddresses/" + std::to_string(entryIdx); 1375 1376 if (thisJson.is_null()) 1377 { 1378 if (thisData != ipv6StaticData.end()) 1379 { 1380 deleteIPv6(ifaceId, thisData->id, asyncResp); 1381 thisData++; 1382 } 1383 else 1384 { 1385 messages::propertyValueFormatError( 1386 asyncResp->res, input.dump(), pathString); 1387 return; 1388 } 1389 entryIdx++; 1390 continue; 1391 } 1392 1393 if (thisJson.empty()) 1394 { 1395 if (thisData != ipv6StaticData.end()) 1396 { 1397 thisData++; 1398 } 1399 else 1400 { 1401 messages::propertyMissing(asyncResp->res, 1402 pathString + "/Address"); 1403 return; 1404 } 1405 entryIdx++; 1406 continue; 1407 } 1408 1409 std::optional<std::string> address; 1410 std::optional<uint8_t> prefixLength; 1411 1412 if (!json_util::readJson(thisJson, asyncResp->res, "Address", 1413 address, "PrefixLength", prefixLength)) 1414 { 1415 return; 1416 } 1417 1418 // if IP address exist then modify it. 1419 if (thisData != ipv6StaticData.end()) 1420 { 1421 // Apply changes 1422 if (address) 1423 { 1424 auto callback = 1425 [asyncResp](const boost::system::error_code ec) { 1426 if (ec) 1427 { 1428 messages::internalError(asyncResp->res); 1429 return; 1430 } 1431 }; 1432 1433 crow::connections::systemBus->async_method_call( 1434 std::move(callback), "xyz.openbmc_project.Network", 1435 "/xyz/openbmc_project/network/" + ifaceId + "/ipv6/" + 1436 thisData->id, 1437 "org.freedesktop.DBus.Properties", "Set", 1438 "xyz.openbmc_project.Network.IP", "Address", 1439 std::variant<std::string>(*address)); 1440 } 1441 1442 if (prefixLength) 1443 { 1444 auto callback = 1445 [asyncResp](const boost::system::error_code ec) { 1446 if (ec) 1447 { 1448 messages::internalError(asyncResp->res); 1449 return; 1450 } 1451 }; 1452 1453 crow::connections::systemBus->async_method_call( 1454 std::move(callback), "xyz.openbmc_project.Network", 1455 "/xyz/openbmc_project/network/" + ifaceId + "/ipv6/" + 1456 thisData->id, 1457 "org.freedesktop.DBus.Properties", "Set", 1458 "xyz.openbmc_project.Network.IP", "PrefixLength", 1459 std::variant<uint8_t>(*prefixLength)); 1460 } 1461 1462 thisData++; 1463 } 1464 else 1465 { 1466 // Create IPv6 with provided data 1467 1468 if (!prefixLength) 1469 { 1470 messages::propertyMissing(asyncResp->res, 1471 pathString + "/PrefixLength"); 1472 continue; 1473 } 1474 1475 if (!address) 1476 { 1477 messages::propertyMissing(asyncResp->res, 1478 pathString + "/Address"); 1479 continue; 1480 } 1481 1482 createIPv6(ifaceId, entryIdx, *prefixLength, *address, 1483 asyncResp); 1484 1485 nlohmann::json &ipv6StaticAddressJson = 1486 asyncResp->res.jsonValue["IPv6StaticAddresses"][entryIdx]; 1487 ipv6StaticAddressJson["Address"] = *address; 1488 ipv6StaticAddressJson["PrefixLength"] = *prefixLength; 1489 } 1490 entryIdx++; 1491 } 1492 } 1493 1494 void parseInterfaceData( 1495 nlohmann::json &json_response, const std::string &iface_id, 1496 const EthernetInterfaceData ðData, 1497 const boost::container::flat_set<IPv4AddressData> &ipv4Data, 1498 const boost::container::flat_set<IPv4AddressData> &ipv4StaticData, 1499 const boost::container::flat_set<IPv6AddressData> &ipv6Data, 1500 const boost::container::flat_set<IPv6AddressData> &ipv6StaticData) 1501 { 1502 json_response["Id"] = iface_id; 1503 json_response["@odata.id"] = 1504 "/redfish/v1/Managers/bmc/EthernetInterfaces/" + iface_id; 1505 json_response["InterfaceEnabled"] = true; 1506 if (ethData.speed == 0) 1507 { 1508 json_response["LinkStatus"] = "NoLink"; 1509 json_response["Status"] = { 1510 {"Health", "OK"}, 1511 {"State", "Disabled"}, 1512 }; 1513 } 1514 else 1515 { 1516 json_response["LinkStatus"] = "LinkUp"; 1517 json_response["Status"] = { 1518 {"Health", "OK"}, 1519 {"State", "Enabled"}, 1520 }; 1521 } 1522 json_response["SpeedMbps"] = ethData.speed; 1523 json_response["MACAddress"] = ethData.mac_address; 1524 json_response["DHCPv4"]["DHCPEnabled"] = ethData.DHCPEnabled; 1525 1526 if (!ethData.hostname.empty()) 1527 { 1528 json_response["HostName"] = ethData.hostname; 1529 if (!ethData.domainnames.empty()) 1530 { 1531 json_response["FQDN"] = 1532 ethData.hostname + "." + ethData.domainnames[0]; 1533 } 1534 } 1535 1536 json_response["VLANs"] = { 1537 {"@odata.id", "/redfish/v1/Managers/bmc/EthernetInterfaces/" + 1538 iface_id + "/VLANs"}}; 1539 1540 json_response["NameServers"] = ethData.nameservers; 1541 json_response["StaticNameServers"] = ethData.nameservers; 1542 1543 nlohmann::json &ipv4_array = json_response["IPv4Addresses"]; 1544 ipv4_array = nlohmann::json::array(); 1545 for (auto &ipv4_config : ipv4Data) 1546 { 1547 1548 std::string gatewayStr = ipv4_config.gateway; 1549 if (gatewayStr.empty()) 1550 { 1551 gatewayStr = "0.0.0.0"; 1552 } 1553 1554 ipv4_array.push_back({{"AddressOrigin", ipv4_config.origin}, 1555 {"SubnetMask", ipv4_config.netmask}, 1556 {"Address", ipv4_config.address}, 1557 {"Gateway", gatewayStr}}); 1558 } 1559 1560 nlohmann::json &ipv4_static_array = 1561 json_response["IPv4StaticAddresses"]; 1562 ipv4_static_array = nlohmann::json::array(); 1563 for (auto &ipv4_static_config : ipv4StaticData) 1564 { 1565 1566 std::string gatewayStr = ipv4_static_config.gateway; 1567 if (gatewayStr.empty()) 1568 { 1569 gatewayStr = "0.0.0.0"; 1570 } 1571 1572 ipv4_static_array.push_back( 1573 {{"SubnetMask", ipv4_static_config.netmask}, 1574 {"Address", ipv4_static_config.address}, 1575 {"Gateway", gatewayStr}}); 1576 } 1577 1578 json_response["IPv6DefaultGateway"] = ethData.ipv6_default_gateway; 1579 1580 nlohmann::json &ipv6_array = json_response["IPv6Addresses"]; 1581 ipv6_array = nlohmann::json::array(); 1582 for (auto &ipv6_config : ipv6Data) 1583 { 1584 ipv6_array.push_back({{"Address", ipv6_config.address}, 1585 {"PrefixLength", ipv6_config.prefixLength}, 1586 {"AddressOrigin", ipv6_config.origin}}); 1587 } 1588 1589 nlohmann::json &ipv6_static_array = 1590 json_response["IPv6StaticAddresses"]; 1591 ipv6_static_array = nlohmann::json::array(); 1592 for (auto &ipv6_static_config : ipv6StaticData) 1593 { 1594 ipv6_static_array.push_back( 1595 {{"Address", ipv6_static_config.address}, 1596 {"PrefixLength", ipv6_static_config.prefixLength}}); 1597 } 1598 } 1599 1600 /** 1601 * Functions triggers appropriate requests on DBus 1602 */ 1603 void doGet(crow::Response &res, const crow::Request &req, 1604 const std::vector<std::string> ¶ms) override 1605 { 1606 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1607 if (params.size() != 1) 1608 { 1609 messages::internalError(asyncResp->res); 1610 return; 1611 } 1612 1613 getEthernetIfaceData( 1614 params[0], 1615 [this, asyncResp, iface_id{std::string(params[0])}]( 1616 const bool &success, const EthernetInterfaceData ðData, 1617 const boost::container::flat_set<IPv4AddressData> &ipv4Data, 1618 const boost::container::flat_set<IPv4AddressData> 1619 &ipv4StaticData, 1620 const boost::container::flat_set<IPv6AddressData> &ipv6Data, 1621 const boost::container::flat_set<IPv6AddressData> 1622 &ipv6StaticData) { 1623 if (!success) 1624 { 1625 // TODO(Pawel)consider distinguish between non existing 1626 // object, and other errors 1627 messages::resourceNotFound(asyncResp->res, 1628 "EthernetInterface", iface_id); 1629 return; 1630 } 1631 1632 // because this has no dependence on the interface at this 1633 // point, it needs to be done after we know the interface 1634 // exists, not before. 1635 getDHCPConfigData(asyncResp); 1636 1637 asyncResp->res.jsonValue["@odata.type"] = 1638 "#EthernetInterface.v1_4_1.EthernetInterface"; 1639 asyncResp->res.jsonValue["@odata.context"] = 1640 "/redfish/v1/$metadata#EthernetInterface.EthernetInterface"; 1641 asyncResp->res.jsonValue["Name"] = "Manager Ethernet Interface"; 1642 asyncResp->res.jsonValue["Description"] = 1643 "Management Network Interface"; 1644 1645 parseInterfaceData(asyncResp->res.jsonValue, iface_id, ethData, 1646 ipv4Data, ipv4StaticData, ipv6Data, 1647 ipv6StaticData); 1648 }); 1649 } 1650 1651 void doPatch(crow::Response &res, const crow::Request &req, 1652 const std::vector<std::string> ¶ms) override 1653 { 1654 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1655 if (params.size() != 1) 1656 { 1657 messages::internalError(asyncResp->res); 1658 return; 1659 } 1660 1661 const std::string &iface_id = params[0]; 1662 1663 std::optional<std::string> hostname; 1664 std::optional<std::string> macAddress; 1665 std::optional<std::string> ipv6DefaultGateway; 1666 std::optional<nlohmann::json> ipv4Addresses; 1667 std::optional<nlohmann::json> ipv4StaticAddresses; 1668 std::optional<nlohmann::json> ipv6Addresses; 1669 std::optional<nlohmann::json> ipv6StaticAddresses; 1670 std::optional<std::vector<std::string>> staticNameServers; 1671 std::optional<std::vector<std::string>> nameServers; 1672 std::optional<nlohmann::json> dhcpv4; 1673 1674 if (!json_util::readJson( 1675 req, res, "HostName", hostname, "IPv4Addresses", ipv4Addresses, 1676 "IPv4StaticAddresses", ipv4StaticAddresses, "MACAddress", 1677 macAddress, "StaticNameServers", staticNameServers, 1678 "IPv6DefaultGateway", ipv6DefaultGateway, "IPv6StaticAddresses", 1679 ipv6StaticAddresses, "NameServers", nameServers, "DHCPv4", 1680 dhcpv4)) 1681 { 1682 return; 1683 } 1684 1685 if (dhcpv4) 1686 { 1687 handleDHCPv4Patch(iface_id, *dhcpv4, asyncResp); 1688 } 1689 1690 // Get single eth interface data, and call the below callback for JSON 1691 // preparation 1692 getEthernetIfaceData( 1693 iface_id, 1694 [this, asyncResp, iface_id, hostname = std::move(hostname), 1695 macAddress = std::move(macAddress), 1696 ipv4Addresses = std::move(ipv4Addresses), 1697 ipv4StaticAddresses = std::move(ipv4StaticAddresses), 1698 ipv6DefaultGateway = std::move(ipv6DefaultGateway), 1699 ipv6StaticAddresses = std::move(ipv6StaticAddresses), 1700 staticNameServers = std::move(staticNameServers), 1701 nameServers = std::move(nameServers)]( 1702 const bool &success, const EthernetInterfaceData ðData, 1703 const boost::container::flat_set<IPv4AddressData> &ipv4Data, 1704 const boost::container::flat_set<IPv4AddressData> 1705 &ipv4StaticData, 1706 const boost::container::flat_set<IPv6AddressData> &ipv6Data, 1707 const boost::container::flat_set<IPv6AddressData> 1708 &ipv6StaticData) { 1709 if (!success) 1710 { 1711 // ... otherwise return error 1712 // TODO(Pawel)consider distinguish between non existing 1713 // object, and other errors 1714 messages::resourceNotFound(asyncResp->res, 1715 "Ethernet Interface", iface_id); 1716 return; 1717 } 1718 1719 if (hostname) 1720 { 1721 handleHostnamePatch(*hostname, asyncResp); 1722 } 1723 1724 if (macAddress) 1725 { 1726 handleMACAddressPatch(iface_id, *macAddress, asyncResp); 1727 } 1728 1729 if (ipv4Addresses) 1730 { 1731 messages::propertyNotWritable(asyncResp->res, 1732 "IPv4Addresses"); 1733 } 1734 1735 if (ipv4StaticAddresses) 1736 { 1737 // TODO(ed) for some reason the capture of ipv4Addresses 1738 // above is returning a const value, not a non-const value. 1739 // This doesn't really work for us, as we need to be able to 1740 // efficiently move out the intermedia nlohmann::json 1741 // objects. This makes a copy of the structure, and operates 1742 // on that, but could be done more efficiently 1743 nlohmann::json ipv4Static = std::move(*ipv4StaticAddresses); 1744 handleIPv4StaticPatch(iface_id, ipv4Static, ipv4StaticData, 1745 asyncResp); 1746 } 1747 1748 if (nameServers) 1749 { 1750 // Data.Permissions is read-only 1751 messages::propertyNotWritable(asyncResp->res, 1752 "NameServers"); 1753 } 1754 1755 if (staticNameServers) 1756 { 1757 handleStaticNameServersPatch(iface_id, *staticNameServers, 1758 asyncResp); 1759 } 1760 1761 if (ipv6DefaultGateway) 1762 { 1763 messages::propertyNotWritable(asyncResp->res, 1764 "IPv6DefaultGateway"); 1765 } 1766 1767 if (ipv6StaticAddresses) 1768 { 1769 nlohmann::json ipv6Static = std::move(*ipv6StaticAddresses); 1770 handleIPv6StaticAddressesPatch(iface_id, ipv6Static, 1771 ipv6StaticData, asyncResp); 1772 } 1773 }); 1774 } 1775 }; 1776 1777 /** 1778 * VlanNetworkInterface derived class for delivering VLANNetworkInterface 1779 * Schema 1780 */ 1781 class VlanNetworkInterface : public Node 1782 { 1783 public: 1784 /* 1785 * Default Constructor 1786 */ 1787 template <typename CrowApp> 1788 VlanNetworkInterface(CrowApp &app) : 1789 Node(app, 1790 "/redfish/v1/Managers/bmc/EthernetInterfaces/<str>/VLANs/<str>", 1791 std::string(), std::string()) 1792 { 1793 entityPrivileges = { 1794 {boost::beast::http::verb::get, {{"Login"}}}, 1795 {boost::beast::http::verb::head, {{"Login"}}}, 1796 {boost::beast::http::verb::patch, {{"ConfigureComponents"}}}, 1797 {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, 1798 {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, 1799 {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; 1800 } 1801 1802 private: 1803 void parseInterfaceData( 1804 nlohmann::json &json_response, const std::string &parent_iface_id, 1805 const std::string &iface_id, const EthernetInterfaceData ðData, 1806 const boost::container::flat_set<IPv4AddressData> &ipv4Data, 1807 const boost::container::flat_set<IPv4AddressData> &ipv4StaticData, 1808 const boost::container::flat_set<IPv6AddressData> &ipv6Data, 1809 const boost::container::flat_set<IPv6AddressData> &ipv6StaticData) 1810 { 1811 // Fill out obvious data... 1812 json_response["Id"] = iface_id; 1813 json_response["@odata.id"] = 1814 "/redfish/v1/Managers/bmc/EthernetInterfaces/" + parent_iface_id + 1815 "/VLANs/" + iface_id; 1816 1817 json_response["VLANEnable"] = true; 1818 if (!ethData.vlan_id.empty()) 1819 { 1820 json_response["VLANId"] = ethData.vlan_id.back(); 1821 } 1822 } 1823 1824 bool verifyNames(const std::string &parent, const std::string &iface) 1825 { 1826 if (!boost::starts_with(iface, parent + "_")) 1827 { 1828 return false; 1829 } 1830 else 1831 { 1832 return true; 1833 } 1834 } 1835 1836 /** 1837 * Functions triggers appropriate requests on DBus 1838 */ 1839 void doGet(crow::Response &res, const crow::Request &req, 1840 const std::vector<std::string> ¶ms) override 1841 { 1842 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1843 // TODO(Pawel) this shall be parameterized call (two params) to get 1844 // EthernetInterfaces for any Manager, not only hardcoded 'openbmc'. 1845 // Check if there is required param, truly entering this shall be 1846 // impossible. 1847 if (params.size() != 2) 1848 { 1849 messages::internalError(res); 1850 res.end(); 1851 return; 1852 } 1853 1854 const std::string &parent_iface_id = params[0]; 1855 const std::string &iface_id = params[1]; 1856 res.jsonValue["@odata.type"] = 1857 "#VLanNetworkInterface.v1_1_0.VLanNetworkInterface"; 1858 res.jsonValue["@odata.context"] = 1859 "/redfish/v1/$metadata#VLanNetworkInterface.VLanNetworkInterface"; 1860 res.jsonValue["Name"] = "VLAN Network Interface"; 1861 1862 if (!verifyNames(parent_iface_id, iface_id)) 1863 { 1864 return; 1865 } 1866 1867 // Get single eth interface data, and call the below callback for JSON 1868 // preparation 1869 getEthernetIfaceData( 1870 params[1], 1871 [this, asyncResp, parent_iface_id{std::string(params[0])}, 1872 iface_id{std::string(params[1])}]( 1873 const bool &success, const EthernetInterfaceData ðData, 1874 const boost::container::flat_set<IPv4AddressData> &ipv4Data, 1875 const boost::container::flat_set<IPv4AddressData> 1876 &ipv4StaticData, 1877 const boost::container::flat_set<IPv6AddressData> &ipv6Data, 1878 const boost::container::flat_set<IPv6AddressData> 1879 &ipv6StaticData) { 1880 if (success && ethData.vlan_id.size() != 0) 1881 { 1882 parseInterfaceData(asyncResp->res.jsonValue, 1883 parent_iface_id, iface_id, ethData, 1884 ipv4Data, ipv4StaticData, ipv6Data, 1885 ipv6StaticData); 1886 } 1887 else 1888 { 1889 // ... otherwise return error 1890 // TODO(Pawel)consider distinguish between non existing 1891 // object, and other errors 1892 messages::resourceNotFound( 1893 asyncResp->res, "VLAN Network Interface", iface_id); 1894 } 1895 }); 1896 } 1897 1898 void doPatch(crow::Response &res, const crow::Request &req, 1899 const std::vector<std::string> ¶ms) override 1900 { 1901 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1902 if (params.size() != 2) 1903 { 1904 messages::internalError(asyncResp->res); 1905 return; 1906 } 1907 1908 const std::string &parentIfaceId = params[0]; 1909 const std::string &ifaceId = params[1]; 1910 1911 if (!verifyNames(parentIfaceId, ifaceId)) 1912 { 1913 messages::resourceNotFound(asyncResp->res, "VLAN Network Interface", 1914 ifaceId); 1915 return; 1916 } 1917 1918 bool vlanEnable = false; 1919 uint64_t vlanId = 0; 1920 1921 if (!json_util::readJson(req, res, "VLANEnable", vlanEnable, "VLANId", 1922 vlanId)) 1923 { 1924 return; 1925 } 1926 1927 // Get single eth interface data, and call the below callback for JSON 1928 // preparation 1929 getEthernetIfaceData( 1930 params[1], 1931 [this, asyncResp, parentIfaceId{std::string(params[0])}, 1932 ifaceId{std::string(params[1])}, &vlanEnable, &vlanId]( 1933 const bool &success, const EthernetInterfaceData ðData, 1934 const boost::container::flat_set<IPv4AddressData> &ipv4Data, 1935 const boost::container::flat_set<IPv4AddressData> 1936 &ipv4StaticData, 1937 const boost::container::flat_set<IPv6AddressData> &ipv6Data, 1938 const boost::container::flat_set<IPv6AddressData> 1939 &ipv6StaticData) { 1940 if (success && !ethData.vlan_id.empty()) 1941 { 1942 auto callback = 1943 [asyncResp](const boost::system::error_code ec) { 1944 if (ec) 1945 { 1946 messages::internalError(asyncResp->res); 1947 } 1948 }; 1949 1950 if (vlanEnable == true) 1951 { 1952 crow::connections::systemBus->async_method_call( 1953 std::move(callback), "xyz.openbmc_project.Network", 1954 "/xyz/openbmc_project/network/" + ifaceId, 1955 "org.freedesktop.DBus.Properties", "Set", 1956 "xyz.openbmc_project.Network.VLAN", "Id", 1957 std::variant<uint32_t>(vlanId)); 1958 } 1959 else 1960 { 1961 BMCWEB_LOG_DEBUG << "vlanEnable is false. Deleting the " 1962 "vlan interface"; 1963 crow::connections::systemBus->async_method_call( 1964 std::move(callback), "xyz.openbmc_project.Network", 1965 std::string("/xyz/openbmc_project/network/") + 1966 ifaceId, 1967 "xyz.openbmc_project.Object.Delete", "Delete"); 1968 } 1969 } 1970 else 1971 { 1972 // TODO(Pawel)consider distinguish between non existing 1973 // object, and other errors 1974 messages::resourceNotFound( 1975 asyncResp->res, "VLAN Network Interface", ifaceId); 1976 return; 1977 } 1978 }); 1979 } 1980 1981 void doDelete(crow::Response &res, const crow::Request &req, 1982 const std::vector<std::string> ¶ms) override 1983 { 1984 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1985 if (params.size() != 2) 1986 { 1987 messages::internalError(asyncResp->res); 1988 return; 1989 } 1990 1991 const std::string &parentIfaceId = params[0]; 1992 const std::string &ifaceId = params[1]; 1993 1994 if (!verifyNames(parentIfaceId, ifaceId)) 1995 { 1996 messages::resourceNotFound(asyncResp->res, "VLAN Network Interface", 1997 ifaceId); 1998 return; 1999 } 2000 2001 // Get single eth interface data, and call the below callback for JSON 2002 // preparation 2003 getEthernetIfaceData( 2004 params[1], 2005 [this, asyncResp, parentIfaceId{std::string(params[0])}, 2006 ifaceId{std::string(params[1])}]( 2007 const bool &success, const EthernetInterfaceData ðData, 2008 const boost::container::flat_set<IPv4AddressData> &ipv4Data, 2009 const boost::container::flat_set<IPv4AddressData> 2010 &ipv4StaticData, 2011 const boost::container::flat_set<IPv6AddressData> &ipv6Data, 2012 const boost::container::flat_set<IPv6AddressData> 2013 &ipv6StaticData) { 2014 if (success && !ethData.vlan_id.empty()) 2015 { 2016 auto callback = 2017 [asyncResp](const boost::system::error_code ec) { 2018 if (ec) 2019 { 2020 messages::internalError(asyncResp->res); 2021 } 2022 }; 2023 crow::connections::systemBus->async_method_call( 2024 std::move(callback), "xyz.openbmc_project.Network", 2025 std::string("/xyz/openbmc_project/network/") + ifaceId, 2026 "xyz.openbmc_project.Object.Delete", "Delete"); 2027 } 2028 else 2029 { 2030 // ... otherwise return error 2031 // TODO(Pawel)consider distinguish between non existing 2032 // object, and other errors 2033 messages::resourceNotFound( 2034 asyncResp->res, "VLAN Network Interface", ifaceId); 2035 } 2036 }); 2037 } 2038 }; 2039 2040 /** 2041 * VlanNetworkInterfaceCollection derived class for delivering 2042 * VLANNetworkInterface Collection Schema 2043 */ 2044 class VlanNetworkInterfaceCollection : public Node 2045 { 2046 public: 2047 template <typename CrowApp> 2048 VlanNetworkInterfaceCollection(CrowApp &app) : 2049 Node(app, "/redfish/v1/Managers/bmc/EthernetInterfaces/<str>/VLANs/", 2050 std::string()) 2051 { 2052 entityPrivileges = { 2053 {boost::beast::http::verb::get, {{"Login"}}}, 2054 {boost::beast::http::verb::head, {{"Login"}}}, 2055 {boost::beast::http::verb::patch, {{"ConfigureComponents"}}}, 2056 {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, 2057 {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, 2058 {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; 2059 } 2060 2061 private: 2062 /** 2063 * Functions triggers appropriate requests on DBus 2064 */ 2065 void doGet(crow::Response &res, const crow::Request &req, 2066 const std::vector<std::string> ¶ms) override 2067 { 2068 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 2069 if (params.size() != 1) 2070 { 2071 // This means there is a problem with the router 2072 messages::internalError(asyncResp->res); 2073 return; 2074 } 2075 2076 const std::string &rootInterfaceName = params[0]; 2077 2078 // Get eth interface list, and call the below callback for JSON 2079 // preparation 2080 getEthernetIfaceList( 2081 [asyncResp, rootInterfaceName{std::string(rootInterfaceName)}]( 2082 const bool &success, 2083 const boost::container::flat_set<std::string> &iface_list) { 2084 if (!success) 2085 { 2086 messages::internalError(asyncResp->res); 2087 return; 2088 } 2089 2090 if (iface_list.find(rootInterfaceName) == iface_list.end()) 2091 { 2092 messages::resourceNotFound(asyncResp->res, 2093 "VLanNetworkInterfaceCollection", 2094 rootInterfaceName); 2095 return; 2096 } 2097 2098 asyncResp->res.jsonValue["@odata.type"] = 2099 "#VLanNetworkInterfaceCollection." 2100 "VLanNetworkInterfaceCollection"; 2101 asyncResp->res.jsonValue["@odata.context"] = 2102 "/redfish/v1/$metadata" 2103 "#VLanNetworkInterfaceCollection." 2104 "VLanNetworkInterfaceCollection"; 2105 asyncResp->res.jsonValue["Name"] = 2106 "VLAN Network Interface Collection"; 2107 2108 nlohmann::json iface_array = nlohmann::json::array(); 2109 2110 for (const std::string &iface_item : iface_list) 2111 { 2112 if (boost::starts_with(iface_item, rootInterfaceName + "_")) 2113 { 2114 iface_array.push_back( 2115 {{"@odata.id", 2116 "/redfish/v1/Managers/bmc/EthernetInterfaces/" + 2117 rootInterfaceName + "/VLANs/" + iface_item}}); 2118 } 2119 } 2120 2121 asyncResp->res.jsonValue["Members@odata.count"] = 2122 iface_array.size(); 2123 asyncResp->res.jsonValue["Members"] = std::move(iface_array); 2124 asyncResp->res.jsonValue["@odata.id"] = 2125 "/redfish/v1/Managers/bmc/EthernetInterfaces/" + 2126 rootInterfaceName + "/VLANs"; 2127 }); 2128 } 2129 2130 void doPost(crow::Response &res, const crow::Request &req, 2131 const std::vector<std::string> ¶ms) override 2132 { 2133 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 2134 if (params.size() != 1) 2135 { 2136 messages::internalError(asyncResp->res); 2137 return; 2138 } 2139 bool vlanEnable = false; 2140 uint32_t vlanId = 0; 2141 if (!json_util::readJson(req, res, "VLANId", vlanId, "VLANEnable", 2142 vlanEnable)) 2143 { 2144 return; 2145 } 2146 // Need both vlanId and vlanEnable to service this request 2147 if (!vlanId) 2148 { 2149 messages::propertyMissing(asyncResp->res, "VLANId"); 2150 } 2151 if (!vlanEnable) 2152 { 2153 messages::propertyMissing(asyncResp->res, "VLANEnable"); 2154 } 2155 if (static_cast<bool>(vlanId) ^ static_cast<bool>(vlanEnable)) 2156 { 2157 return; 2158 } 2159 2160 const std::string &rootInterfaceName = params[0]; 2161 auto callback = [asyncResp](const boost::system::error_code ec) { 2162 if (ec) 2163 { 2164 // TODO(ed) make more consistent error messages based on 2165 // phosphor-network responses 2166 messages::internalError(asyncResp->res); 2167 return; 2168 } 2169 messages::created(asyncResp->res); 2170 }; 2171 crow::connections::systemBus->async_method_call( 2172 std::move(callback), "xyz.openbmc_project.Network", 2173 "/xyz/openbmc_project/network", 2174 "xyz.openbmc_project.Network.VLAN.Create", "VLAN", 2175 rootInterfaceName, vlanId); 2176 } 2177 }; 2178 } // namespace redfish 2179