修改以太网接口资源信息

命令功能

配置以太网接口，目前只支持IPV4的修改，同一网口的IP列表个数最多为4个。

命令格式

操作类型：PATCH

URL：https://device_ip/redfish/v1/Systems/EthernetInterfaces/<eth_Id>

请求头：

X-Auth-Token: auth_value

Content-Type: header_type

请求消息体：

{
    "IPv4Addresses": [{
        "Address": Address,
        "SubnetMask": SubnetMask,
        "AddressOrigin": AddressOrigin,
        "VlanId": VlanId,
        "Gateway": Gateway,
        "Tag": Tag,
        "ConnectTest": ConnectTest,
        "RemoteTestIp": RemoteTestIp
    }]
}

URL参数

表1 URL参数
参数名	是否必选	参数说明	取值
<eth_Id>	必选	网口资源的ID。	OS侧显示的网口名，取值为GMAC0或GMAC1。

请求参数

表2 请求参数
参数名	是否必选	参数说明	取值
IPv4Addresses	必选	IPv4地址信息。	列表类型，长度1~4，IPv4地址的其他字段信息。
Address	必选	IPv4地址	字符串，IPv4地址。
SubnetMask	必选	IPv4地址的子网掩码	字符串，IPv4地址的子网掩码。
AddressOrigin	必选	IPv4地址获取模式	字符串，可设置为“Static”。
VlanId	可选	虚拟局域网标识符	数字或者null，数字有效范围为1 ~ 4094。
Gateway	必选	IPv4网关地址	字符串或者null，IPv4网关地址。
Tag	必选	IPv4地址用途标签	字符串且非null，支持大小写字母（a~z、A~Z）、数字（0~9）、下划线（_），最大长度为32个字符。
ConnectTest	可选	是否对新增或修改的IP地址以及网关进行连通性测试	布尔值，取值为true或false。
RemoteTestIp	可选	对新增或修改的IP地址进行连通性测试的远端IP地址	字符串，IPv4地址。注意不能和“Address”参数的配置相同。说明：如果要配置ConnectTest和RemoteTestIp，两个参数必须同时配置。只有当ConnectTest选择True时，此字段才有效，web端新增ip时默认需要进行联通性测试。

使用指南

无

使用实例

请求样例：

PATCH https://10.10.10.10/redfish/v1/Systems/EthernetInterfaces/GMAC0

请求头：

X-Auth-Token: auth_value

Content-Type: application/json

请求消息体：

{
    "IPv4Addresses":[{
        "Address":"xx.xx.xx.xx",
        "SubnetMask":"255.255.0.0",
        "AddressOrigin":"Static",
        "Gateway":"",
        "VlanId":null,
        "Tag":"net"
    },
    {
        "Address":"10.10.10.xx",
       "SubnetMask":"255.255.0.0",
       "Gateway":"10.10.10.xx",
       "VlanId":null,
       "Tag":"test",
       "ConnectTest":true,
       "RemoteTestIp":"xx.xx.xx.xx",
       "AddressOrigin":"Static"
    }]
}

响应样例：

{
    "@odata.context": "/redfish/v1/$metadata#Systems/Members/1/EthernetInterfaces/Members/$entity",
    "@odata.type": "#EthernetInterface.v1_8_0.EthernetInterface",
    "@odata.id": "/redfish/v1/Systems/1/EthernetInterfaces/GMAC0",
    "Id": "GMAC0",
    "Name": "eth0",
    "IPv4Addresses": [{
            "Address": "xx.xx.xx.xx",
            "SubnetMask": "255.255.0.0",
            "AddressOrigin": "Static",
            "Gateway": "xx.xx.xx.xx",
            "VlanId": null,
            "Tag": "net"
        },
        {
            "Address": "xx.xx.xx.xx",
            "SubnetMask": "255.255.0.0",
            "AddressOrigin": "Static",
            "Gateway": "xx.xx.xx.xx",
            "VlanId": null,
            "Tag": "test"
        }],
    "Oem": {
        "StartTime": "2020-11-12T20:17:03+0000",
        "TaskState": "Running",
        "TaskPercentage": "ok"
    }
}

响应码：202

输出说明

表3 操作输出说明
字段	类型	说明
@odata.context	字符串	配置以太网任务资源模型的OData描述信息。
@odata.id	字符串	当前任务资源的访问路径。说明：您可以访问该资源，获取该任务的详细信息。
@odata.type	字符串	配置以太网任务资源的类型。
Id	字符串	配置以太网任务资源的ID。
Name	字符串	配置以太网任务资源的名称。
IPv4Addresses	对象	配置以太网任务的IPv4地址表。
Address	字符串	配置以太网任务的IPv4地址。
SubnetMask	字符串	配置以太网任务的子网掩码。
AddressOrigin	字符串	配置以太网任务的地址来源。 Static DHCP
Gateway	字符串	配置以太网任务的网关。
VlanId	字符串	配置以太网任务的Vlan ID。
Tag	字符串	配置以太网任务的IP地址用途标签。
Oem	对象	自定义字段。
StartTime	字符串	配置以太网任务的起始时间。
TaskState	字符串	配置以太网任务资源的状态。 New Starting Running Suspended Interrupted Pending Stopping Completed Killed Exception Service
TaskPercentage	字符串	配置以太网任务完成进度。

父主题： 网络管理