doc-exports/docs/bms/api-ref/en-us_topic_0229339179.html
guoyanyan c311ecafe3 bms_api_0510
Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com>
Co-authored-by: guoyanyan <guoyanyan3@huawei.com>
Co-committed-by: guoyanyan <guoyanyan3@huawei.com>
2023-10-11 08:28:11 +00:00

10 KiB

Modifying Attributes of a BMS NIC

Function

This API is used to specify whether to delete a NIC when the BMS is deleted or the NIC is detached.

URI

PUT /v1/{project_id}/baremetalservers/{server_id}/os-interface/{port_id}

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).

port_id

Yes

Specifies the BMS NIC ID.

Request

  • Request parameters

    Parameter

    Mandatory

    Type

    Description

    interface_attachment

    Yes

    Object

    Specifies the attribute to be modified. For details, see Table 2.

    Table 2 interface_attachment field data structure description

    Parameter

    Mandatory

    Type

    Description

    delete_on_termination

    Yes

    Boolean

    Specifies whether to delete a NIC when the BMS is deleted or the NIC is detached.

  • Example request
    {
        "interface_attachment" : {
            "delete_on_termination": false
        }
    }

Response

None

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.