Querying NICs Attached to a BMS¶

Function¶

This API is used to query information about NICs attached to a BMS, such as the IP address and MAC address of each NIC.

URI¶

GET /v1/{project_id}/baremetalservers/{server_id}/os-interface

Table 1 lists the parameters.

**Table 1** Parameter description¶
Parameter	Mandatory	Description
project_id	Yes	Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
server_id	Yes	Specifies the BMS ID. You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).

Request¶

Request parameters
None

Example request

GET https://{BMS Endpoint}/v1/c685484a8cc2416b97260938705deb65/baremetalservers/95bf2490-5428-432c-ad9b-5e3406f869dd/os-interface

Response¶

Response parameters

Parameter	Type	Description
interfaceAttachments	Array of objects	Specifies BMS NICs. For details, see Table 2.

**Table 2** **interfaceAttachments** field data structure description¶
Parameter	Type	Description
port_state	String	Specifies the NIC port status. The value can be ACTIVE, BUILD, or DOWN.
fixed_ips	Array of objects	Specifies private IP addresses of NICs. For details, see Table 3.
net_id	String	Specifies the ID of the subnet (network_id) to which the NIC ports belong.
port_id	String	Specifies the ID of the NIC port.
mac_addr	String	Specifies the MAC address of the NIC.
driver_mode	String	Specifies the NIC driver type in Guest OS. The value can be virtio or hinic. The default value is virtio.
pci_address	String	Specifies the BDF number of the NIC in Linux Guest OS.

**Table 3** **fixed_ips** field data structure description¶
Parameter	Type	Description
subnet_id	String	Specifies the ID of the subnet (subnet_id) corresponding to the private IP address of the NIC.
ip_address	String	Specifies the NIC private IP address.

Example response

{
    "interfaceAttachments": [
        {
            "port_state": "ACTIVE",
            "fixed_ips": [
                {
                    "subnet_id": "a5052101-11e1-4f3d-a5fa-f6ba6791219c",
                    "ip_address": "192.168.1.147"
                }
            ],
            "net_id": "ad0fadbf-4bc1-472c-a030-5310e53b3818",
            "port_id": "bb585b04-f2a2-4528-9064-fd0aeb4e15a9",
            "mac_addr": "fa:16:3e:3b:58:fc"
        }
    ]
}

Returned Values¶

Normal values

Returned Values	Description
200	The request has been successfully processed.

For details about other returned values, see Status Codes.

Error Codes¶

See Error Codes.

last updated: 2024-12-10 11:18 UTC - commit: cf05cf92cd8e8941e14b67ba9cbdd0d2223ce9a4