Loading
close

裸金属端口

time 更新时间:2024-06-24 11:39:53

裸金属端口

裸金属端口列表

功能介绍

获取裸金属端口列表

URI

GET /v1/ports/detail

请求消息

参数 参数类型 是否必选 描述
node string 按裸金属节点名称过滤
node_uuid string 按裸金属节点 UUID 过滤
portgroup string 按裸金属端口组名称过滤
address string 按裸金属端口 MAC 地址过滤
sort_key string 按裸金属端口属性排序

响应消息

参数 参数类型 描述
ports array 端口数据
uuid string 端口 UUID
address string 端口 MAC 地址
node_uuid string 端口所属的裸金属节点 UUID
portgroup_uuid string 端口所属的端口组 UUID
local_link_connection JSON 端口的 LLDP 信息
pxe_enabled boolean 端口是否使用 PXE 启动
physical_network string 端口所属的物理网络
internal_info JSON 端口内部属性, 只读
extra JSON 端口额外属性
created_at string 端口创建时间
updated_at string 端口更新时间
links array 端口相关的链接
is_smartnic boolean 端口是否是智能网卡

请求示例

正常响应示例

{
  "ports": [
    {
      "address": "11:11:11:11:11:11",
      "created_at": "2016-08-18T22:28:48.643434+11:11",
      "extra": {},
      "internal_info": {},
      "is_smartnic": true,
      "links": [
        {
          "href": "http://127.0.0.1:6385/v1/ports/d2b30520-907d-46c8-bfee-c5586e6fb3a1",
          "rel": "self"
        },
        {
          "href": "http://127.0.0.1:6385/ports/d2b30520-907d-46c8-bfee-c5586e6fb3a1",
          "rel": "bookmark"
        }
      ],
      "local_link_connection": {
        "port_id": "Ethernet3/1",
        "switch_id": "0a:1b:2c:3d:4e:5f",
        "switch_info": "switch1"
      },
      "node_uuid": "6d85703a-565d-469a-96ce-30b6de53079d",
      "physical_network": "physnet1",
      "portgroup_uuid": "e43c722c-248e-4c6e-8ce8-0d8ff129387a",
      "pxe_enabled": true,
      "updated_at": null,
      "uuid": "d2b30520-907d-46c8-bfee-c5586e6fb3a1"
    }
  ]
}

正常响应代码

200

错误码

裸金属端口详情

功能介绍

获取裸金属端口详情信息

URI

GET /v1/ports/{port_id}

请求消息

参数 参数类型 是否必选 描述
port_id string 端口 UUID
fields string 返回的数据字段

响应消息

参数 参数类型 描述
uuid string 端口 UUID
address string 端口 MAC 地址
node_uuid string 端口所属的裸金属节点 UUID
portgroup_uuid string 端口所属的端口组 UUID
local_link_connection JSON 端口的 LLDP 信息
pxe_enabled boolean 端口是否使用 PXE 启动
physical_network string 端口所属的物理网络
internal_info JSON 端口内部属性, 只读
extra JSON 端口额外属性
created_at string 端口创建时间
updated_at string 端口更新时间
links array 端口相关的链接
is_smartnic boolean 端口是否是智能网卡

请求示例

正常响应示例

{
  "address": "11:11:11:11:11:11",
  "created_at": "2016-08-18T22:28:48.643434+11:11",
  "extra": {},
  "internal_info": {},
  "is_smartnic": true,
  "links": [
    {
      "href": "http://127.0.0.1:6385/v1/ports/d2b30520-907d-46c8-bfee-c5586e6fb3a1",
      "rel": "self"
    },
    {
      "href": "http://127.0.0.1:6385/ports/d2b30520-907d-46c8-bfee-c5586e6fb3a1",
      "rel": "bookmark"
    }
  ],
  "local_link_connection": {
    "port_id": "Ethernet3/1",
    "switch_id": "0a:1b:2c:3d:4e:5f",
    "switch_info": "switch1"
  },
  "node_uuid": "6d85703a-565d-469a-96ce-30b6de53079d",
  "physical_network": "physnet1",
  "portgroup_uuid": "e43c722c-248e-4c6e-8ce8-0d8ff129387a",
  "pxe_enabled": true,
  "updated_at": null,
  "uuid": "d2b30520-907d-46c8-bfee-c5586e6fb3a1"
}

正常响应代码

200

错误码

创建裸金属端口

功能介绍

创建裸金属端口

URI

POST /v1/ports

请求消息

参数 参数类型 是否必选 描述
node_uuid string 裸金属节点 UUID
address string 端口 MAC 地址
portgroup_uuid string 端口所属端口组 UUID
local_link_connection JSON 端口的 LLDP 信息。参数包括交换机ID switch_id,端口ID port_id,端口VLAN vlan_id,交换机名称switch_info。在对接SDN网络服务且采用动态配置SDN网络方案下,switch_id传”00:00:00:00:00:00”,port_id传”default”,vlan_id传实际端口vlan,交换机名称传对应裸金属网关节点switch-info label的值
pxe_enabled boolean 端口是否用于 PXE 启动, 默认为false,是则传true
physical_network string 端口的物理网络信息
extra JSON 端口的额外信息。如果有元数据信息,可以以键值对形式传入
is_smartnic boolean 端口是否为智能网卡,默认为False

响应消息

参数 参数类型 描述
uuid string 端口 UUID
address string 端口 MAC 地址
node_uuid string 端口所属的裸金属节点 UUID
portgroup_uuid string 端口所属的端口组 UUID
local_link_connection JSON 端口的 LLDP 信息
pxe_enabled boolean 端口是否使用 PXE 启动
physical_network string 端口所属的物理网络
internal_info JSON 端口内部属性, 只读
extra JSON 端口额外属性
created_at string 端口创建时间
updated_at string 端口更新时间
links array 端口相关的链接
is_smartnic boolean 端口是否是智能网卡

请求示例

{
    "node_uuid": "6d85703a-565d-469a-96ce-30b6de53079d",
    "address": "11:11:11:11:11:11",
    "local_link_connection": {
        "switch_id": "00:00:00:00:00:00",
        "port_id": "default",
        "switch_info": "switch1",
        "vlan_id": "231"
    },
    "pxe_enabled": true
    "extra": {
        "test": "test_data"
    }
}

正常响应示例

{
  "address": "11:11:11:11:11:11",
  "created_at": "2016-08-18T22:28:48.643434+11:11",
  "extra": {},
  "internal_info": {},
  "is_smartnic": true,
  "links": [
    {
      "href": "http://127.0.0.1:6385/v1/ports/d2b30520-907d-46c8-bfee-c5586e6fb3a1",
      "rel": "self"
    },
    {
      "href": "http://127.0.0.1:6385/ports/d2b30520-907d-46c8-bfee-c5586e6fb3a1",
      "rel": "bookmark"
    }
  ],
  "local_link_connection": {
    "port_id": "Ethernet3/1",
    "switch_id": "0a:1b:2c:3d:4e:5f",
    "switch_info": "switch1"
  },
  "node_uuid": "6d85703a-565d-469a-96ce-30b6de53079d",
  "physical_network": "physnet1",
  "portgroup_uuid": "e43c722c-248e-4c6e-8ce8-0d8ff129387a",
  "pxe_enabled": true,
  "updated_at": null,
  "uuid": "d2b30520-907d-46c8-bfee-c5586e6fb3a1"
}

正常响应代码

201

错误码

编辑裸金属端口

功能介绍

编辑裸金属端口信息

URI

PATCH /v1/ports/{port_id}

请求消息

参数 参数类型 是否必选 描述
port_id string 端口 UUID

响应消息

参数 参数类型 描述
uuid string 端口 UUID
address string 端口 MAC 地址
node_uuid string 端口所属的裸金属节点 UUID
portgroup_uuid string 端口所属的端口组 UUID
local_link_connection JSON 端口的 LLDP 信息
pxe_enabled boolean 端口是否使用 PXE 启动
physical_network string 端口所属的物理网络
internal_info JSON 端口内部属性, 只读
extra JSON 端口额外属性
created_at string 端口创建时间
updated_at string 端口更新时间
links array 端口相关的链接
is_smartnic boolean 端口是否是智能网卡

请求示例

[
   {
      "path" : "/address",
      "value" : "22:22:22:22:22:22",
      "op" : "replace"
   }
]

正常响应示例

{
  "address": "22:22:22:22:22:22",
  "created_at": "2016-08-18T22:28:48.643434+11:11",
  "extra": {},
  "internal_info": {},
  "is_smartnic": true,
  "links": [
    {
      "href": "http://127.0.0.1:6385/v1/ports/d2b30520-907d-46c8-bfee-c5586e6fb3a1",
      "rel": "self"
    },
    {
      "href": "http://127.0.0.1:6385/ports/d2b30520-907d-46c8-bfee-c5586e6fb3a1",
      "rel": "bookmark"
    }
  ],
  "local_link_connection": {
    "port_id": "Ethernet3/1",
    "switch_id": "0a:1b:2c:3d:4e:5f",
    "switch_info": "switch1"
  },
  "node_uuid": "6d85703a-565d-469a-96ce-30b6de53079d",
  "physical_network": "physnet1",
  "portgroup_uuid": "e43c722c-248e-4c6e-8ce8-0d8ff129387a",
  "pxe_enabled": true,
  "updated_at": "2016-08-18T22:28:49.653974+00:00",
  "uuid": "d2b30520-907d-46c8-bfee-c5586e6fb3a1"
}

正常响应代码

200

错误码

删除裸金属端口

功能介绍

删除裸金属端口

URI

DELETE /v1/ports/{port_id}

请求消息

参数 参数类型 是否必选 描述
port_id string 端口 UUID

响应消息

请求示例

正常响应示例

正常响应代码

204

错误码

此篇文章对你是否有帮助?
没帮助
locked-file

您暂无权限访问该产品