修改物理网口LLDP工作模式(ChangeHostNetworkInterfaceLldpMode)

API请求

URLs

PUT zstack/v1/hostNetworkInterface/lldp/actions

Headers

Authorization: OAuth the-session-uuid

Body

{
  "changeHostNetworkInterfaceLldpMode": {
    "interfaceUuids": [
      "f37102496ac2357aaa214622322adb65"
    ],
    "mode": "rx_only"
  },
  "systemTags": [],
  "userTags": []
}

Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"changeHostNetworkInterfaceLldpMode":{"interfaceUuids":["f37102496ac2357aaa214622322adb65"],"mode":"rx_only"}}' \
http://localhost:8080/zstack/v1/hostNetworkInterface/lldp/actions

参数列表

名字	类型	位置	描述	可选值	起始版本
interfaceUuids	List	body (包含在changeHostNetworkInterfaceLldpMode结构中)	物理网口UUID		5.0.0
mode(可选)	String	body (包含在changeHostNetworkInterfaceLldpMode结构中)	LLDP工作模式	rx_only tx_only rx_and_tx disable	5.0.0
systemTags (可选)	List	body	系统标签		5.0.0
userTags (可选)	List	body	用户标签		5.0.0

API返回

返回示例

{
  "inventories": [
    {
      "interfaceUuid": "1cae08c11e8530a8bf892df7ef709249",
      "mode": "rx_only"
    }
  ]
}

名字	类型	描述	起始版本
success	boolean		5.0.0
inventories	List	详情参考inventrories	5.0.0
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	5.0.0

#inventories

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	5.0.0
interfaceUuid	String	物理网口Uuid	5.0.0
mode	String	LLDP工作模式	5.0.0
createDate	Timestamp	创建时间	5.0.0
lastOpDate	Timestamp	最后一次修改时间	5.0.0
lldp	HostNetworkInterfaceLldpRefInventory	详情参考lldp	5.0.0

#lldp

名字	类型	描述	起始版本
lldpUuid	String	LLDP UUID	5.0.0
chassisId	String	机箱标识	5.0.0
timeToLive	Integer	生存时间	5.0.0
managementAddress	String	管理地址	5.0.0
systemName	String	系统名称	5.0.0
systemDescription	String	系统描述	5.0.0
systemCapabilities	String	系统能力	5.0.0
portId	String	端口标识	5.0.0
portDescription	String	端口描述	5.0.0
vlanId	Integer	VLAN标识	5.0.0
aggregationPortId	Long	聚合端口标识	5.0.0
mtu	Integer	最大传输单元	5.0.0
createDate	Timestamp	创建时间	5.0.0
lastOpDate	Timestamp	最后一次修改时间	5.0.0

#error

名字	类型	描述	起始版本
code	String	错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001	5.0.0
description	String	错误的概要描述	5.0.0
details	String	错误的详细信息	5.0.0
elaboration	String	保留字段，默认为null	5.0.0
opaque	LinkedHashMap	保留字段，默认为null	5.0.0
cause	ErrorCode	根错误，引发当前错误的源错误，若无原错误，该字段为null	5.0.0

SDK示例

Java SDK

ChangeHostNetworkInterfaceLldpModeAction action = new ChangeHostNetworkInterfaceLldpModeAction();
action.interfaceUuids = asList("f37102496ac2357aaa214622322adb65");
action.mode = "rx_only";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
ChangeHostNetworkInterfaceLldpModeAction.Result res = action.call();

Python SDK

ChangeHostNetworkInterfaceLldpModeAction action = ChangeHostNetworkInterfaceLldpModeAction()
action.interfaceUuids = [f37102496ac2357aaa214622322adb65]
action.mode = "rx_only"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
ChangeHostNetworkInterfaceLldpModeAction.Result res = action.call()

上一篇更新物理机IPMI信息(UpdateHostIpmi)下一篇获取物理网口LLDP信息(GetHostNetworkInterfaceLldp)