ResourceDefinition

uris

/redfish/v1/Managers/manager_id/NICs/nicid

properties

名称	类型	是否只读	取值范围/枚举值	说明
@odata.context	string	true	-	指定NIC资源模型的OData描述信息
@odata.id	string	true	-	指定NIC资源的访问路径
@odata.type	string	true	-	指定NIC资源类型
Id	string	true	-	指定NIC资源的ID
IPv6StaticAddresses [ {	array	true	-	IPv6静态地址列表
IPv6StaticAddresses[].Address	string	true	-	地址
IPv6StaticAddresses[].PrefixLength	number	true	-	IPv6前缀长度
} ]
IPv6StaticDefaultGateways [ {	array	true	-	IPv6静态默认网关列表
IPv6StaticDefaultGateways[].Address	string	true	-	地址
} ]
Name	string	true	-	指定NIC资源的名称
InterfaceEnabled	boolean	false	-	指定NIC接口使能状态
PermanentMACAddress	null	true	-	指定NIC资源的MAC地址
HostName	string	false	-	指定NIC资源的主机名
FQDN	string	false	-	指定NIC资源的全称域名
VLAN {	object	true	-	VLAN配置信息
VLAN.VLANEnable	boolean	true	-	指定NIC资源VLAN功能的使能状态，包括： ● true ● false
VLAN.VLANId	number	true	-	指定NIC资源所属VLAN的ID
}
DHCPv4 {	object	true	-	DHCPv4配置信息
DHCPv4.UseDNSServers	boolean	true	true,false	DHCPv4是否使用DNS服务器
DHCPv4.DHCPEnabled	boolean	true	-	DHCP v4的开启状态
}
IPv4Addresses [ {	array	false	-	指定NIC的IPv4地址信息
IPv4Addresses[].Address	string	true	-	地址
IPv4Addresses[].AddressOrigin	string	true	-	地址分配方式
IPv4Addresses[].Gateway	string	true	-	指定BMC网口的IPv4网关地址
IPv4Addresses[].SubnetMask	string	true	-	指定BMC网口的IPv4地址对应的子网掩码
} ]
IPv4StaticAddresses [ {	array	true	-	IPv4静态地址列表
IPv4StaticAddresses[].Address	string	true	-	地址
IPv4StaticAddresses[].Gateway	string	true	-	网关
IPv4StaticAddresses[].SubnetMask	string	true	-	子网掩码
} ]
IPv6Addresses [ {	array	false	-	指定NIC的IPv6地址信息
IPv6Addresses[].Address	string	true	-	地址
IPv6Addresses[].AddressOrigin	string	true	-	地址分配方式
IPv6Addresses[].PrefixLength	number	true	-	IPv6前缀长度
} ]
IPv6DefaultGateway	string	true	-	指定NIC资源当前使用的IPv6网关地址
DHCPv6 {	object	true	-	DHCPv6配置信息
DHCPv6.UseDNSServers	boolean	true	true,false	DHCPv6是否使用DNS服务器
DHCPv6.OperatingMode	string	true	-	DHCP v6的开启状态，包括： ● Disabled：关闭 ● Stateful：全状态模式。使用DHCP v6配置IPv6地址和其他DHCP选项
}
NameServers[ ]	array	true	-	指定NIC资源当前使用的域名服务器地址。数组第一项表示主域名服务器，第二项表示备份域名服务器1，第三项表示备份域名服务器2
StaticNameServers[ ]	array	false	-	指定NIC资源的静态域名服务器地址。数组第一项表示主域名服务器，第二项表示备份域名服务器1，第三项表示备份域名服务器2说明指定动态模式获取DNS服务器信息时，显示为当前使用的DNS服务器地址。
Oem {	object	true	-	自定义属性
Oem.Public {	object	true	-	自定义属性
Oem.Public.IPVersion	string	false	-	IPv4/IPv6协议使能，包括： ● IPv4：只使能IPv4 ● IPv6：只使能IPv6 ● IPv4AndIPv6：同时使能IPv4和IPv6
Oem.Public.DNSAddressOrigin	string	false	-	DNS服务器地址来源，包括： ● Static：来自手动配置 ● IPv4：来自DHCPv4 ● IPv6：来自DHCPv6
}
}
Links {	object	true	-	指定NIC资源相关链接信息
Links.Oem {	object	true	-	自定义属性
Links.Oem.Public {	object	false	-	自定义属性
Links.Oem.Public.EthernetInterface {	object	true	-	主机以太网资源集合的访问路径，专用和汇聚网口为null
Links.Oem.Public.EthernetInterface.@odata.id	null	true	-	EthernetInterface资源的访问路径
}
}
}
}

supported_methods

GET
PATCH

HTTP methods

GET

命令功能

查询指定 NIC 资源

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/NICs/nicid

请求头:

X-Auth-Token: auth_value

请求消息体: 无

参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6地址
auth_value	请求消息的鉴权参数	可通过/redfish/v1/SessionService/Sessions创建会话时获得

使用指南

BMC 3.7及以上版本支持

使用实例

请求样例： GET https://device_ip/redfish/v1/Managers/manager_id/NICs/nicid

X-Auth-Token: auth_value 请求消息体：无

响应样例：

json

{
  "@odata.context": "/redfish/v1/$metadata#EthernetInterface.EthernetInterface",
  "@odata.id": "/redfish/v1/Managers/1/NICs/DedicatedPort1",
  "@odata.type": "#EthernetInterface.v1_5_0.EthernetInterface",
  "Id": "DedicatedPort1",
  "Name": "Manager Dedicated Network Interface Port1",
  "InterfaceEnabled": true,
  "PermanentMACAddress": null,
  "HostName": "iBMC",
  "FQDN": "iBMC",
  "VLAN": {
    "VLANEnable": false,
    "VLANId": 80
  },
  "IPv4Addresses": [
    {
      "Address": "10.10.10.10",
      "SubnetMask": "255.255.0.0",
      "AddressOrigin": "Static",
      "Gateway": "10.10.0.1"
    }
  ],
  "IPv4StaticAddresses": [
    {
      "Address": "10.10.10.10",
      "SubnetMask": "255.255.0.0",
      "Gateway": "10.10.0.1"
    },
    {
      "Address": "192.168.2.100",
      "SubnetMask": "255.255.255.0"
    }
  ],
  "DHCPv4": {
    "DHCPEnabled": false,
    "UseDNSServers": false
  },
  "IPv6StaticAddresses": [
    {
      "Address": "fd00::2019",
      "PrefixLength": 64
    }
  ],
  "IPv6DefaultGateway": "fd00::2017",
  "IPv6StaticDefaultGateways": [
    {
      "Address": "fd00::2017"
    }
  ],
  "IPv6Addresses": [
    {
      "Address": "fd00::2019",
      "PrefixLength": 64,
      "AddressOrigin": "Static"
    },
    {
      "Address": "fe80::f61d:6bff:fef8:8173",
      "PrefixLength": 64,
      "AddressOrigin": "LinkLocal"
    },
    {
      "Address": "fd00:226::f61d:6bff:fef8:8173",
      "AddressOrigin": "SLAAC",
      "PrefixLength": 64
    }
  ],
  "DHCPv6": {
    "OperatingMode": "Disabled",
    "UseDNSServers": false
  },
  "NameServers": [
    "10.10.2.6",
    "fd00::2010",
    "10.10.2.7"
  ],
  "StaticNameServers": [
    "10.10.2.6",
    "fd00::2010",
    "10.10.2.7"
  ],
  "Oem": {
    "Public": {
      "IPVersion": "IPv4AndIPv6",
      "DNSAddressOrigin": "Static"
    }
  },
  "Links": {
    "Oem": {
      "Public": {
        "EthernetInterface": {
          "@odata.id": null
        }
      }
    }
  }
}

响应码：200

PATCH

命令功能

修改指定 NIC 资源

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/NICs/nicid

请求头:

X-Auth-Token: auth_value
Content-Type: header_type
If-Match: ifmatch_value

请求消息体:

json

{
  "InterfaceEnabled": interface_enabled,
  "HostName": host_name,
  "FQDN": fqdn,
  "VLAN": vlan,
  "IPv4StaticAddresses": [
    ipv4_static
  ],
  "DHCPv4": dhcp_v4,
  "IPv6Addresses": [
    ipv6_addr
  ],
  "IPv6StaticAddresses": [
    ipv6_static
  ],
  "IPv6StaticDefaultGateways": [
    ipv6_static_gw
  ],
  "DHCPv6": dhcp_v6,
  "StaticNameServers": [
    name_servers
  ],
  "Oem": {
    "Public": {
      "IPVersion": ip_version,
      "DNSAddressOrigin": dns_address_origin
    }
  }
}

URL参数说明

参数	参数说明	取值
nicid	NIC资源ID	格式如下，id是网口编号：DedicatedPortid AggregationPort1 LOMPortid LOM2Portid PCIePortid OCPPortid

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
InterfaceEnabled	指定NIC接口的使能状态，布尔类型	只能设置为true，若当前URL表示的网口未使能，开启使能不能和本资源内的其他属性同时设置
HostName	主机名	取值范围：1 ～ 64位的字符串取值原则：可由数字、英文字母和连字符（-）组成，且连字符不能出现在开头和结尾
FQDN	全称域名	格式为：主机名.域名
VLAN	VLAN信息格式为： { "VLANEnable": state, "VLANId": vlanid }	● state：VLAN的使能状态，可设置为“true” 和“false” ● vlanid：1~4094说明1. vlanid只支持整数，当输入值为小数时，会上报属性格式错2. URL中nicid决定此处配置的是专用网口还是NCSI网口的VLAN信息 ● 当nicid为DedicatedPortid时，配置的是专用网口的VLAN ● 当nicid不为DedicatedPortid时，配置的是NCSI网口的VLAN 3. 多网口组机型不支持设置专用网口VLAN
IPv4StaticAddresses	静态IPv4地址信息，格式为： { "Address":"Address", "SubnetMask":"SubnetMask", "Gateway":"Gateway" } 备份IPv4地址信息，格式为： { "Address":"Address", "SubnetMask":"SubnetMask" }	● Address：IPv4地址 ● SubnetMask：IPv4地址的子网掩码 ● Gateway：IPv4网关地址
DHCPv4	DHCP v4信息，格式为： { "DHCPEnabled": dhcpenabled, "UseDNSServers": use_dns }	● dhcpenabled：布尔类型，true表示开启DHCP v4，false表示关闭 ● use_dns：布尔类型，true表示使用DHCP v4分配的域名服务器，false表示不使用
IPv6Addresses	IPv6信息，格式为： { "Address": ipv6_addr }	● ipv6_addr：IPv6地址
IPv6StaticAddresses	静态IPv6信息，格式为： { "Address": ipv6_addr, "PrefixLength": ipv6_prefix }	● ipv6_addr：IPv6地址 ● ipv6_prefix：IPV6前缀长度
IPv6StaticDefaultGateways	静态IPv6网关信息，格式为： { "Address": ipv6_gw }	● ipv6_gw：IPv6静态网关地址
DHCPv6	DHCP v6信息，格式为： { "OperatingMode": op_mode, "UseDNSServers": use_dns }	● op_mode：字符串类型，Stateful表示开启DHCP v6，Disabled表示关闭 ● use_dns：布尔类型，true表示使用DHCP v6分配的域名服务器，false表示不使用
StaticNameServers	静态域名服务器地址	服务器的IP地址可以为IPv4或IPv6。数组第一项表示主域名服务器地址，第二项表示备份域名服务器1，第三项表示备份域名服务器2说明仅DNS服务器信息获取模式为手动配置时可以修改。
IPVersion	IPv4/IPv6协议使能	● IPv4：只使能IPv4 ● IPv6：只使能IPv6 ● IPv4AndIPv6：IPv4和IPv6都使能
DNSAddressOrigin	DNS服务器地址来源	● IPv4：从IPv4协议栈自动获取 ● Static：手动配置 ● IPv6：从IPv6协议栈自动获取

使用指南

BMC 3.7及以上版本支持

使用实例

请求样例： PATCH https://device_ip/redfish/v1/Managers/manager_id/NICs/nicid

X-Auth-Token: auth_value Content-Type: header_type If-Match: ifmatch_value 请求消息体：

json

{
  "InterfaceEnabled": interface_enabled,
  "HostName": host_name,
  "FQDN": fqdn,
  "VLAN": vlan,
  "IPv4StaticAddresses": [
    ipv4_static
  ],
  "DHCPv4": dhcp_v4,
  "IPv6Addresses": [
    ipv6_addr
  ],
  "IPv6StaticAddresses": [
    ipv6_static
  ],
  "IPv6StaticDefaultGateways": [
    ipv6_static_gw
  ],
  "DHCPv6": dhcp_v6,
  "StaticNameServers": [
    name_servers
  ],
  "Oem": {
    "Public": {
      "IPVersion": ip_version,
      "DNSAddressOrigin": dns_address_origin
    }
  }
}

响应样例：

json

{
  "@odata.context": "/redfish/v1/$metadata#EthernetInterface.EthernetInterface",
  "@odata.id": "/redfish/v1/Managers/1/NICs/DedicatedPort1",
  "@odata.type": "#EthernetInterface.v1_5_0.EthernetInterface",
  "Id": "DedicatedPort1",
  "Name": "Manager Dedicated Network Interface Port1",
  "InterfaceEnabled": true,
  "PermanentMACAddress": null,
  "HostName": "iBMC",
  "FQDN": "iBMC",
  "VLAN": {
    "VLANEnable": false,
    "VLANId": 80
  },
  "IPv4Addresses": [
    {
      "Address": "10.10.10.10",
      "SubnetMask": "255.255.0.0",
      "AddressOrigin": "Static",
      "Gateway": "10.10.0.1"
    }
  ],
  "IPv4StaticAddresses": [
    {
      "Address": "10.10.10.10",
      "SubnetMask": "255.255.0.0",
      "Gateway": "10.10.0.1"
    },
    {
      "Address": "192.168.2.100",
      "SubnetMask": "255.255.255.0"
    }
  ],
  "DHCPv4": {
    "DHCPEnabled": false,
    "UseDNSServers": false
  },
  "IPv6StaticAddresses": [
    {
      "Address": "fd00::2019",
      "PrefixLength": 64
    }
  ],
  "IPv6DefaultGateway": "fd00::2017",
  "IPv6StaticDefaultGateways": [
    {
      "Address": "fd00::2017"
    }
  ],
  "IPv6Addresses": [
    {
      "Address": "fd00::2019",
      "PrefixLength": 64,
      "AddressOrigin": "Static"
    },
    {
      "Address": "fe80::f61d:6bff:fef8:8173",
      "PrefixLength": 64,
      "AddressOrigin": "LinkLocal"
    },
    {
      "Address": "fd00:226::f61d:6bff:fef8:8173",
      "AddressOrigin": "SLAAC",
      "PrefixLength": 64
    }
  ],
  "DHCPv6": {
    "OperatingMode": "Disabled",
    "UseDNSServers": false
  },
  "NameServers": [
    "10.10.2.6",
    "fd00::2010",
    "10.10.2.7"
  ],
  "StaticNameServers": [
    "10.10.2.6",
    "fd00::2010",
    "10.10.2.7"
  ],
  "Oem": {
    "Public": {
      "IPVersion": "IPv4AndIPv6",
      "DNSAddressOrigin": "Static"
    }
  },
  "Links": {
    "Oem": {
      "Public": {
        "EthernetInterface": {
          "@odata.id": null
        }
      }
    }
  }
}

响应码：200

ResourceDefinition ​

uris ​

properties ​

supported_methods ​

HTTP methods ​

GET ​

PATCH ​

ResourceDefinition

uris

properties

supported_methods

HTTP methods

GET

PATCH