NSX-T Data Center REST API
# ***************************************************************************
# Copyright 2020-2024 VMware, Inc. All rights reserved. VMware Confidential.
# ***************************************************************************
BareMetalServerInterface (schema)
| Name | Description | Type | Notes |
|---|---|---|---|
| _last_sync_time | Timestamp of last modification | EpochMsTimestamp | Readonly Sortable |
| _links | References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST. |
array of ResourceLink | Readonly |
| _schema | Schema for this resource | string | Readonly |
| _self | Link to this resource | SelfResourceLink | Readonly |
| bms_external_id | BMS External ID External ID of the bare metal server to which this interface belongs. |
string | |
| description | Description of this resource | string | Maximum length: 1024 Sortable |
| display_name | Identifier to use when displaying entity in logs or GUI Defaults to ID if not set |
string | Maximum length: 255 Sortable |
| external_id | External id External id to identify the bare metal server interface in the NSX. |
string | Required |
| ip_addresses | IP address IP Addresses of the bare metal server interface |
array of string | |
| is_mgmt_interface | Flag for management interface It is a boolean flag which indicates whether the interface is management interface or not If set to true, indicates the given interface is management interface If set to false, indicates the given interface is not management interface. |
boolean | |
| mac_address | MAC address MAC address of the bare metal server interface. |
string | |
| resource_type | Must be set to the value BareMetalServerInterface | string | Required |
| scope | List of scopes for discovered resource Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC. |
array of DiscoveredResourceScope | |
| source_id | Source id Id of the bare metal controller (BMC) which is discovering Bare Metal Server. |
string | |
| state | State State of the the bare metal server interface. |
string | Enum: INVALID, UNKNOWN, UP, DOWN |
| tags | Opaque identifiers meaningful to the API user | array of Tag | Maximum items: 30 |