1. BMC Network Management Introduction ​

The main responsibility of bmc_network is IPv4/IPv6 configuration, ensuring normal BMC network communication from two perspectives:

1. Configuring external IP addresses: Users can connect to the BMC via the management IP address configured on the BMC.
2. Configuring internal IP addresses: These are primarily used for network communication between the management board and the BMC, or between multiple BMCs within the same chassis.

Networking example

The eth0.702 (702 is the VLAN ID) network port device belongs to the internal network port group on the 171.31.1.x subnet.

eth0.701, eth2, and eth3 belong to the external network port group on the xx.xx.16.x subnet. External IP addresses switch among these three network port devices. Currently, eth0 and eth2 are mostly used.

2. BMC Network Management Objects ​

2.1 Common Objects ​

IPv4 ​

This class primarily carries IPv4 information for external network ports, including the IP address, subnet mask, default gateway, address acquisition mode (DHCP or Static), backup IP address (activated in DHCP mode), and backup subnet mask. It also provides modification interfaces for these properties.

IPv6 ​

This class primarily carries IPv6 information for external network ports, including the IP address, prefix length, default gateway, and address acquisition mode (DHCPv6 or Static). It also provides modification interfaces for these properties (see 4. Common BMC Network Interfaces for interface usage).

EthernetInterfaces ​

This class primarily carries most of the information for external network ports.

MgmtPort ​

This class primarily carries physical NIC information.

LldpConfig ​

This class primarily carries LLDP-related configurations.

LLDPInfo ​

This class primarily carries information related to LLDP packet parsing.

Assembly ​

This class primarily carries information related to LLDP packet parsing.

Group ​

This class currently primarily persists the MAC address of external network ports.

EthMac ​

This class primarily carries network port hardware-related configurations.

HeartBeat ​

This class primarily carries internal network heartbeat configuration.

EthGroup ​

This class primarily carries configurations for internal networks, multiple external network ports, and maintenance network ports.

Relationships Between Classes ​

2.2 Common Customization Items ​

Customization item document

2.3 Common Network CSR Configurations ​

Network configuration CSR file: The platform.sr file of the corresponding model in the vpd repository.

eth0 and eth2 as External Network Ports, Both Using IP and MAC Addresses Sourced from IPv4/IPv6 Objects ​

        "EthMac_Eth0": {
            "EthId": 0,
            "EthName": "eth0",
            "GroupId": "EthGroup0",
            "Mac": "20:22:01:75:BC:60",
            "MacUseEnabled": false,
            "SpeedDuplexEnable": true,
            "SpeedSetting": 0,
            "DuplexSetting": 0
        },
        "EthMac_Eth2": {
            "EthId": 2,
            "EthName": "eth2",
            "GroupId": "EthGroup0",
            "Mac": "20:22:01:75:BC:60",
            "MacUseEnabled": true,
            "SpeedDuplexEnable": true,
            "SpeedSetting": 0,
            "DuplexSetting": 0
        }

Note: The same GroupId indicates that eth0 and eth2 belong to the same external network port group. Both network ports use the MAC address of the port where MacUseEnabled is set to true. That is, eth0 uses the MAC address of eth2.

Dual Network Port Configuration (Both the NC-SI and Dedicated Port Configured with External IP Addresses), With the Dedicated Port Using the IPv4 Object and New Port Using the EthGroup Object ​

        "EthMac_Eth0": {
            "EthId": 0,
            "EthName": "eth0",
            "GroupId": "EthGroup0",
            "Mac": "20:22:01:75:BC:60",
            "MacUseEnabled": false,
            "SpeedDuplexEnable": true,
            "SpeedSetting": 0,
            "DuplexSetting": 0
        },
        "EthMac_Eth2": {
            "EthId": 2,
            "EthName": "eth2",
            "GroupId": "EthGroup0",
            "Mac": "20:22:01:75:BC:60",
            "MacUseEnabled": true,
            "SpeedDuplexEnable": true,
            "SpeedSetting": 0,
            "DuplexSetting": 0
        },
        "EthGroup_OutEthGroup1": {
            "Name": "OutEthGroup1",
            "GroupId": 0,
            "OutType": 2,
            "ActiveEthId": 0,
            "InnerNetWork": "",
            "VLANId": 4092,
            "VLANEnabled": false,
            "EthAlias": 255,
            "IpAddr":"192.168.2.200",
            "BackupIpAddr": "",
            "BaseIpAddr": "",
            "SubnetMask": "255.255.255.0",
            "BackUpSubnetMask": "",
            "DefaultGateway": "192.168.2.200",
            "IpPolicy": 0,
            "Status": true,
            "IpMode": "DHCP",
            "Ipv6Mode": "Static",
            "Ipv6Addr": "",
            "PrefixLength": 0,
            "Ipv6DefaultGateway": "",
            "AssociatedPortType": 1,
            "Channel": 2
        },
        "IPMIChannel_LAN2": {
            "ChanType": 4,
            "Instance": 2,
            "ChanPro": 1,
            "ChannelID": 2,
            "DestAddr": 32,
            "SrcAddr": 0,
            "MedType": 4
        }

2.4 bmc_network External Network Initialization Process ​

2.5 bmc_network Internal Network Initialization Process ​

2.6 DHCP Task Process ​

3. Network Features ​

3.1 Configuring the IPv4 Address ​

IPv4 addresses can be set in either of the following ways:

1. Set static IPv4 information, including the IP address, subnet mask, and gateway.
2. Set the DHCP mode, where The DHCP server dynamically distributes IPv4 information. You can also configure a backup IPv4 address and subnet mask. If DHCP fails to obtain an IP address, the BMC can still be accessed via the backup IP address.

3.2 Configuring the IPv6 Address ​

IPv6 addresses can be set in any of the following ways:

1. Set static IPv6 information, including the IP address, prefix, and gateway.
2. Set the DHCPv6 mode for dynamically distributed IPv6 information.
3. Use SLAAC to automatically configure stateless addresses.

3.3 External Network Port Switching ​

BMC network devices typically come in two types: dedicated network ports and NC-SI network ports. A dedicated network port is the own management port of the BMC (usually eth2). An NC-SI network port refers to a port shared between the BMC and other network devices in the server via NC-SI (usually eth0). Network port switching refers to the switching of external network configurations between the dedicated port and the NC-SI port. For example, when switching from a dedicated port to an NC-SI port, the external IP address on eth2 will be cleared, and eth0 will be reconfigured with the external IP address. There are two modes for switching external network ports:

1. Manually switching to a specified network port.
2. Setting adaptive mode: The connected network port with the highest priority is automatically selected. (The dedicated network port usually has the highest priority.)

3.4 External Network VLAN Configuration ​

VLAN configuration includes dedicated network port VLAN and NC-SI network port VLAN. After a VLAN is configured, the BMC network port only processes packets with the corresponding VLAN tag, effectively partitioning a virtual LAN.

3.5 Network Port Configuration ​

1. Network port MAC address configuration: You can modify the the MAC address of a BMC network port using the ipmi command. Generally, the MAC address is fixed after being set during equipment.
2. Network port speed configuration: You can customize the network port speed and half/full duplex mode in auto-negotiation or non-auto-negotiation mode.
3. Network ports up/down support: All network ports are brought up during initialization. Interfaces are also provided for bringing up/down network ports.

4. Common BMC Network Interfaces ​

4.1 busctl Interfaces ​

Setting IPv4 Information ​

Set the IP address, subnet mask, and gateway using busctl. Pass the four-part IP address, subnet mask, and gateway in order:

busctl --user call bmc.kepler.bmc_network /bmc/kepler/Managers/1/EthernetInterfaces/Ipv4 bmc.kepler.Managers.EthernetInterfaces.Ipv4 SetIpMaskGateway a&#123;ss&#125;sss 3 Interface a UserName a ClientAddr a <ipaddr> <mask> <gateway>

Set the IP address and subnet mask using busctl. Pass the four-part IP address and subnet mask in order:

busctl --user call bmc.kepler.bmc_network /bmc/kepler/Managers/1/EthernetInterfaces/Ipv4 bmc.kepler.Managers.EthernetInterfaces.Ipv4 SetIpAddr a&#123;ss&#125;ss 3 Interface a UserName a ClientAddr a <ipaddr> <mask>

Set the gateway using busctl:

busctl --user call bmc.kepler.bmc_network /bmc/kepler/Managers/1/EthernetInterfaces/Ipv4 bmc.kepler.Managers.EthernetInterfaces.Ipv4 SetDefaultGateway a&#123;ss&#125;s 3 Interface a UserName a ClientAddr a <gateway>

Setting IPv6 Information ​

Set the IP address, prefix length, and gateway using busctl. Pass the IP address, prefix length, and gateway in order:

busctl --user call bmc.kepler.bmc_network /bmc/kepler/Managers/1/EthernetInterfaces/Ipv6 bmc.kepler.Managers.EthernetInterfaces.Ipv6 SetIpv6PrefixGateway a&#123;ss&#125;sis 3 Interface a UserName a ClientAddr a <ipaddr> <prefix> <gateway>

Set the IP address and prefix length using busctl. Pass the IP address and prefix length in order:

busctl --user call bmc.kepler.bmc_network /bmc/kepler/Managers/1/EthernetInterfaces/Ipv6 bmc.kepler.Managers.EthernetInterfaces.Ipv6 SetIpAddr a&#123;ss&#125;si 3 Interface a UserName a ClientAddr a <ipaddr> <prefix>

Set the gateway using busctl:

busctl --user call bmc.kepler.bmc_network /bmc/kepler/Managers/1/EthernetInterfaces/Ipv6 bmc.kepler.Managers.EthernetInterfaces.Ipv6 SetDefaultGateway a&#123;ss&#125;s 3 Interface a UserName a ClientAddr a <ipaddr> <prefix>

External Network Port Switching ​

Switch network ports using busctl:

busctl --user call bmc.kepler.bmc_network /bmc/kepler/Managers/1/EthernetInterfaces bmc.kepler.Managers.EthernetInterfaces SetNetworkConfig a&#123;ss&#125;sybq 3 Interface a UserName a ClientAddr a <network_mode> <port_ID> <NCSI_VLAN_enable> <NSCI_VLAN_ID>

Parameters:

1. network_mode: The value can be Automatic or Fixed. Pass Fixed when switching to a specified network port, or Automatic to set adaptive mode.
2. port_ID: This parameter takes effect only when NetMode is set to Fixed. It represents the ID of the network port to switch to (the ID of the dedicated port is usually 1).
3. NCSI_VLAN_enable: The value is a Boolean value indicating whether to enable the VLAN function for the NC-SI network port.
4. NSCI_VLAN_ID: This parameter is effective only when the VLAN function is enabled. If the VLAN function is disabled, the value is 0.

External Network VLAN Configuration ​

Notes: Configuration will cause network disconnection. You need to configure the same VLAN in the LAN. You can connect to the network through the serial port. Query method: Use the ifconfig command. Set the VLAN using busctl:

busctl --user call bmc.kepler.bmc_network /bmc/kepler/Managers/1/EthernetInterfaces bmc.kepler.Managers.EthernetInterfaces SetVLANConfig a&#123;ss&#125;bqy 3 Interface a UserName a ClientAddr a <VLAN_enable> <VLAN_ID> <port_type>

Parameters:

1. VLAN_enable: The value is a Boolean value indicating whether to enable the VLAN function.
2. VLAN_ID: This parameter is effective only when the VLAN function is enabled. If the VLAN function is disabled, the value is 0.
3. port_type: The value 0 indicates setting the VLAN of NC-SI, and the value 1 indicates setting the VLAN of the dedicated network port.

Network Port Configuration ​

Setting the Network Port Speed ​

Use ethtool <EthName> or cat /sys/class/net/<EthName>/speed to query the network port speed. Set network port speed using busctl:

busctl --user call bmc.kepler.bmc_network /bmc/kepler/Managers/1/EthernetInterfaces/Eth bmc.kepler.Managers.EthernetInterfaces.EthConfig SetSpeed a&#123;ss&#125;sbyy 3 Interface a UserName a ClientAddr a <EthName> <SpeedDuplexEnable> <SpeedSetting> <DuplexSetting>

Parameters:

1. EthName: For example, eth2 and eth0.
2. SpeedDuplexEnable: The value is a Boolean value, indicating whether to enable the auto-negotiation mode for the network port.
3. SpeedSetting: The value can be 0 for N/A (pass 0 when auto-negotiation is enabled), 1 for 10 Mbit/s, 2 for 100 Mbit/s, and 3 for 1,000 Mbit/s.
4. DuplexSetting: The value can be 0 for N/A (pass 0 when auto-negotiation is enabled), 1 for half-duplex, and 2 for full-duplex.

Setting the Network Port Status ​

Run ipmcget -d ethport to query the port status. Set the network port status using busctl:

busctl --user call bmc.kepler.bmc_network /bmc/kepler/Managers/1/EthernetInterfaces bmc.kepler.Managers.EthernetInterfaces SetEthState a&#123;ss&#125;sb 3 Interface a UserName a ClientAddr a <EthName> <port_status>

Parameters:

1. EthName: For example, eth2 and eth0.
2. port_status: The value is a Boolean value. true indicates bringing up the network port. false indicates bringing down the network port.

4.2 CLI Interfaces ​

Setting IPv4 Information ​

Set the static IPv4 address, subnet mask, and gateway using the CLI. Pass the four-part IP address, subnet mask, and gateway (optional) in order after -v:

ipmcset -d ipaddr -v <ipaddr> <mask> [gateway]

Set the static IPv4 gateway using the CLI:

ipmcset -d gateway -v <gateway>

Set the IPv4 mode to DHCP or Static using the CLI:

ipmcset -d ipmode -v <dhcp|static>

Setting IPv6 Information ​

Set the static IPv6 address, prefix length, and gateway using the CLI. Pass the IP address, prefix length, and gateway (optional) in order after -v:

ipmcset -d ipaddr6 -v <ipaddr> <prefix> [gateway]

Set the static IPv6 gateway using the CLI:

ipmcset -d gateway6 -v <gateway>

Set the IPv6 mode to DHCPv6 or Static using the CLI:

ipmcset -d ipmode6 -v <dhcp|static>

External Network Port Switching ​

Set the network mode using the CLI. Pass 1 for a fixed network port or 2 for adaptive mode:

ipmcset -d netmode -v <network_mode>

Switch network ports using the CLI (switching is possible only in fixed network port mode):

ipmcset -d activeport -v <port_type> <port_id>

Parameters:

1. port_type: Set 0 for a dedicated network port, 1 for LOM, and 2 for PCIe.
2. port_id: Set the index of the port for the specified network port type. (Port IDs start from 0. If the network port type is 0, this parameter is optional.)

4.3 IPMI Interfaces ​

Setting IPv4 Information ​

Setting the External IPv4 Address ​

ipmitool -H <BMC_IP_address> -I lanplus -p 623 -U <username> -P <password> -C 17 raw 0x0c 0x01 0x01 0x03 <four-byte_IP_address>

Setting the External IPv4 Subnet Mask ​

ipmitool -H <BMC_IP_address> -I lanplus -p 623 -U <username> -P <password> -C 17 raw 0x0c 0x01 0x01 0x06 <four-byte_subnet_mask>

Setting the External IPv4 Gateway ​

ipmitool -H <BMC_IP_address> -I lanplus -p 623 -U <username> -P <password> -C 17 raw 0x0c 0x01 0x01 0x0c <four-byte_gateway>

Setting the External IPv4 Mode ​

ipmitool -H <BMC_IP_address> -I lanplus -p 623 -U <username> -P <password> -C 17 raw 0x0c 0x01 0x01 0x04 <one-byte_mode>

The last byte represents the mode: 0x01 (Static) or 0x02 (DHCP).

Note:

1. If only IPv6 is enabled, the IPv4 address, subnet mask, and gateway cannot be set.
2. If the current mode is DHCP, it will change to Static mode after configuration.
3. Passing all zeros for the IP address clears the IPv4 address (the subnet mask and gateway are also cleared).
4. Passing all zeros for the subnet mask clears the IPv4 subnet mask (the gateway is also cleared).
5. If the configured gateway is not in the same subnet as the current IP address, the operation fails.
6. Passing all zeros for the gateway clears the IPv4 gateway.

Querying the External IPv4 Address ​

ipmitool -H <BMC_IP_address> -I lanplus -p 623 -U <username> -P <password> -C 17 raw 0x0c 0x02 0x01 0x03 0x00 0x00

Querying the External IPv4 Subnet Mask ​

ipmitool -H <BMC_IP_address> -I lanplus -p 623 -U <username> -P <password> -C 17 raw 0x0c 0x02 0x01 0x06 0x00 0x00

Querying the External IPv4 Gateway ​

ipmitool -H <BMC_IP_address> -I lanplus -p 623 -U <username> -P <password> -C 17 raw 0x0c 0x02 0x01 0x0c 0x00 0x00

Querying the External IPv4 Mode ​

ipmitool -H <BMC_IP_address> -I lanplus -p 623 -U <username> -P <password> -C 17 raw 0x0c 0x02 0x01 0x04 0x00 0x00

The first byte returned is always 11, and the following bytes are the query result.

Setting IPv6 Information ​

Setting the External IPv6 Address ​

ipmitool -H <BMC_IP_address> -I lanplus -p 623 -U <username> -P <password> -C 17 raw 0x0c 0x01 0x01 0xcc <three-byte_vendor_ID> <sixteen-byte_IPv6_address>

Setting the External IPv6 Prefix Length ​

ipmitool -H <BMC_IP_address> -I lanplus -p 623 -U <username> -P <password> -C 17 raw 0x0c 0x01 0x01 0xcd <three-byte_vendor_ID> <one-byte_prefix_length>

Setting the External IPv6 Gateway ​

ipmitool -H <BMC_IP_address> -I lanplus -p 623 -U <username> -P <password> -C 17 raw 0x0c 0x01 0x01 0xce <three-byte_vendor_ID> <sixteen-byte_gateway>

Setting the External IPv6 Mode ​

ipmitool -H <BMC_IP_address> -I lanplus -p 623 -U <username> -P <password> -C 17 raw 0x0c 0x01 0x01 0xd0 <three-byte_vendor_ID> <one-byte_mode>

Querying the External IPv6 Address ​

ipmitool -H <BMC_IP_address> -I lanplus -p 623 -U <username> -P <password> -C 17 raw 0x0c 0x02 0x01 0xcc 0x00 0x00

Querying the External IPv6 Prefix Length ​

ipmitool -H <BMC_IP_address> -I lanplus -p 623 -U <username> -P <password> -C 17 raw 0x0c 0x02 0x01 0xcd 0x00 0x00

Querying the External IPv6 Gateway (Gateway Address Passed in Little-Endian Format) ​

ipmitool -H <BMC_IP_address> -I lanplus -p 623 -U <username> -P <password> -C 17 raw 0x0c 0x02 0x01 0xce 0x00 0x00

Querying the External IPv6 Mode ​

ipmitool -H <BMC_IP_address> -I lanplus -p 623 -U <username> -P <password> -C 17 raw 0x0c 0x02 0x01 0xd0 0x00 0x00

The first byte returned is always 11, the following three bytes are the vendor ID, and the following bytes are the query result.

Setting the Network Mode ​

ipmitool -H <BMC_IP_address> -I lanplus -p 623 -U <username> -P <password> -C 17 raw 0x0c 0x01 0x01 <three-byte_vendor_ID> <one-byte_network_mode>

The network mode can be 1 (dedicated network port), 3 (adaptive mode), or 4 (PCIe mode, where the first port is used by default).

Setting the VLAN ​

ipmitool -H <BMC_IP_address> -I lanplus -p 623 -U <username> -P <password> -C 17 raw 0x30 0x93 <three-byte_vendor_ID> 0x5a 0x1a 0x00 0x04 0x00 <one-byte_port_type> <one-byte_VLAN_enable> <two-byte_VLAN_ID>

Parameters:

1. port_type: The value 0 indicates setting the VLAN of NC-SI, and the value 1 indicates setting the VLAN of the dedicated network port.
2. VLAN_enable: The value 0 indicates that the VLAN is disabled, and the value 1 indicates that the VLAN is enabled.
3. VLAN_ID: The value consists of two bytes, where the lower four bits of the first byte and the entire second byte form a 12-bit number.

4.4 RPC Interfaces ​

IPv4 ​

Ipv4SetIpAddr ​

Callback function: set_ipv4_addr

Function: Sets the IPv4 address, passing only the IP address and subnet mask.

Prerequisites:

1. The input IPv4 address is valid.
2. The input subnet mask is valid.
3. ip_version supports IPv4.
4. No subnet conflicts exist with the internal network or maintenance IP addresses.

Note: The DHCP client will be stopped if this interface is used in DHCP mode, and the static address mode will be used.

Function implementation:

1. Modify resource tree and database information.
2. Record operation logs.
3. Set the IPv4 address and subnet mask through a socket (core implementation).
4. Update iptables rules in the network address translation (NAT) table for the external network.
5. Emit signals for IPv4 address and subnet mask changes.
6. Clear alias network ports.
7. Modify iptables rules when the IP address changes.
8. Broadcast ARP packets.

Ipv4SetDefaultGateway ​

Callback function: set_ipv4_gateway

Function: Sets the IPv4 gateway independently.

Prerequisites:

1. The input gateway address is valid.
2. ip_version supports IPv4.
3. The current gateway and the IP address to be set are in the same subnet.

Function implementation:

1. Modify resource tree and database information (DefaultGateway).
2. Record operation logs.
3. Set the IPv4 address through a socket (core implementation).
4. Emit signals for IPv4 gateway changes.
5. Broadcast ARP packets.

Ipv4SetIpMaskGateway ​

Callback function: set_ipv4_mask_gateway

Function: Sets the IPv4 address, passing the IP address, subnet mask, and gateway.

Prerequisites:

1. The input parameters are valid.
2. The subnets are the same.
3. The IP address does not conflict with other IP addresses.

Note: The DHCP client will be stopped if this interface is used in DHCP mode, and the static address mode will be used.

Function implementation:

1. Modify the database and resource tree.
2. Record operation logs.
3. Set the IPv4 address, subnet mask, and default gateway through a socket (core implementation).
4. Update iptables rules in the NAT table for the external network.
5. Modify iptables rules when the IP address changes.
6. Emit signals for IPv4 information changes.
7. Clear alias network ports.
8. Broadcast ARP packets.

Ipv4SetDedicatedMaintIpMask ​

Callback function: set_dedicated_maint_ipv4_mask

Function: Sets the IPv4 address and subnet mask for dedicated port O&M.

Prerequisites:

1. The input parameters are valid.
2. The subnets are the same.
3. The IP address does not conflict with other IP addresses.

Function implementation:

1. Update the dedicated O&M network:
   • Set the IPv4 address and subnet mask of the O&M network port through a socket (core implementation).
   • Set route_localnet to 1 to ensure services like Web and SSH function normally.
   • Update iptables rules in the NAT table for the O&M network.
   • After the O&M network port is configured, ARP address resolution points to the maintenance IP address. Therefore, the external network port needs to actively send ARP packets to trigger address learning for the external IP address.
2. Record operation logs.

IPv6 ​

Ipv6SetIpAddr ​

Callback function: set_ipv6_addr

Function: Sets the IPv6 address, passing only the IP address and prefix length. ipv6_addr must be in the shortest string format, such as fe80::.

Prerequisites:

1. The IPv6 address is valid.
2. The prefix length is valid (the maximum prefix length is 128 bits).
3. ip_version supports IPv6.

Note:

1. If the passed prefix length is 0, the default value of 64 is used.
   
2. Disable the DHCPv6 service first if the DHCP mode is used.

Function implementation:

1. Record operation logs.
2. Modify the database and resource tree.
3. Delete the previous IPv6 information through a socket.
4. Set new IPv6 information through a socket (core implementation).
5. Emit signals for IPv6 address and prefix length changes.
6. Send Neighbor Advertisement (NA) packets.
7. Modify ip6tables rules when the IPv6 address changes.

Ipv6SetDefaultGateway ​

Callback function: set_ipv6_gateway

Function: Sets the IPv6 gateway independently.

Prerequisites:

1. The gateway is valid.
2. The gateway to be set is in the same subnet as the current IP address.
3. ip_version supports IPv6.

Function implementation:

1. Record operation logs.
2. Modify resource tree and database information (DefaultGateway).
3. Delete the previous IPv6 gateway through a socket.
4. Set a new IPv6 gateway through a socket (core implementation).
5. Emit signals for IPv6 gateway changes.

Ipv6SetIpv6PrefixGateway ​

Callback function: set_ipv6_prefix_gateway

Function: Sets the IPv6 address, passing the IP address, prefix length, and gateway.

Prerequisites:

1. In Redfish scenarios, configuration is required if either IpAddr or PrefixLength is valid.
2. The IP address, prefix length, and gateway are valid.
3. The gateway to be set is in the same subnet as the current IP address.
4. ip_version supports IPv6.

Note:

1. In Redfish scenarios, an error will be reported if the IPv6 address is invalid.
   
2. Disable the DHCPv6 service first if the DHCP mode is used.
   
3. If the passed prefix length is 0, the default value of 64 is used.

Function implementation:

1. Record operation logs.
2. Modify resource tree and database information.
3. Delete the previous IPv6 gateway through a socket.
4. Set a new IPv6 gateway through a socket (core implementation).
5. Delete the previous IPv6 information through a socket.
6. Set new IPv6 information through a socket (core implementation).
7. Emit signals for IPv6 address, prefix length, and gateway changes.
8. Send NA packets.
9. Modify ip6tables rules when the IPv6 address changes.

Ethernet ​

EthernetInterfacesGetAllPort ​

Callback function: get_all_port

Function implementation:

Traverse slot.Port and return all port information:

• Id
• EthId
• DeviceId
• DevicePortId
• Silkscreen
• Type
• AdaptiveFlag
• LinkStatus
• Mac

EthernetInterfacesSetNetworkConfig ​

Callback function: set_network_config

Function: Sets network configuration.

Input parameters: NetMode, PortId, VLANEnable, and VLANId

Prerequisites:

1. The network configuration does not conflict with the internal VLAN.
2. The port ID is valid.
3. In adaptive mode, the port remains unchanged from the previous one, and interface parameters are not accepted.
4. If only vlan_id is modified while VLANEnable is false, the network is not restarted.

Function implementation:

1. NetMode includes the adaptive mode and fixed network port mode.
2. Update database and resource tree information.
3. Switch the network port and restart the network, updating multi-IP address configurations for the external network port.
4. Restart the network if the VLAN information of the NC-SI network port changes.

EthernetInterfacesAddMgmtPort ​

Callback function: add_mgmt_port

Function: Adds a management port.

Note:

1. If portId is not 0, the existing port is updated. Otherwise, a port with the specified portId is registered.
   
2. A value of 0 indicates a new registration, and a portId must be automatically generated.
   
3. Modification of the dedicated network port is not supported.

Function implementation:

1. Add a resource tree object.

EthernetInterfacesDeleteMgmtPort ​

Callback function: delete_mgmt_port

Function: Deletes a management port.

Note:

1. When portId is 255, all NC-SI network ports are deleted.
   
2. Dedicated network ports cannot be deleted.

Function implementation:

1. Delete the resource tree object.

EthernetInterfacesSetVLANConfig ​

Callback function: rpc_set_vlan

Function: Sets the VLAN.

Prerequisites:

1. The network configuration does not conflict with the internal VLAN.
2. The vlan_id is within the range of 1 to 4094.

Function implementation:

1. Set vlan_id based on portType. Currently, only two types are supported: 0 for NCSI and 1 for Dedicated.
2. Determine whether the current model supports VLAN configuration for the dedicated network port. If not, return a failure message directly.

HeartBeatBeat ​

Callback function: heart_beat:beat

Function: Provides heartbeats.

EthernetInterfacesNetworkFailover ​

Callback function: network_failover

Function: Updates the network failover status.

Note: When the LAN switch (LSW) switches ports, ARP packets and NA packets are actively sent.

iptables ​

EthernetInterfacesAddIptablesRule ​

Callback function: add_iptables_rule

Input parameters: interface_name and ip_addr

Note:

1. Operation logs are not recorded when this RPC method is called internally between SSDP components.
   
2. The input parameter validation includes checks for special characters.

Function implementation:

1. Implement the function using iptables commands of the OS.

EthernetInterfacesAddIp6tablesRule ​

Callback function: add_ip6tables_rule

Input parameters: interface_name and ipv6_addr

Note:

1. Operation logs are not recorded when this RPC method is called internally between SSDP components.
   
2. The input parameter validation includes checks for special characters.

Function implementation:

1. Implement the function using ip6tables commands of the OS.

NatConfigAddNatRule ​

Callback function: add_nat_rule

Function: Adds an address mapping rule.

Input parameters: service_name and reg_params

Note:

1. Currently, only one forwarding rule with a specified IP address can be added for a network port type.
   
2. Based on the forwarding rules of all running services, a rule for forwarding from ps.Address to an internal address is added. Currently, only IPv4 addresses are supported.

Function implementation:

1. add_multi_nat_rules or add_single_nat_rule
2. Implement the function using iptables commands of the OS.

NatConfigUpdateNatRule ​

Callback function: update_nat_rule

Function: Updates an address mapping rule.

Input parameters: service_name and reg_params

Function implementation:

1. update_multi_nat_rules or update_single_nat_rule.
2. Implement the function using iptables commands of the OS.
3. If the network port is unavailable, set route_localnet to 0.