NSX-T Data Center REST API

BareMetalServerInterface (type)

{
  "additionalProperties": false,
  "extends": {
    "$ref": "DiscoveredResource"
  },
  "id": "BareMetalServerInterface",
  "module_id": "BareMetalServerInventory",
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp",
      "can_sort": true,
      "description": "Timestamp of last modification",
      "readonly": true
    },
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
      "items": {
        "$ref": "ResourceLink"
      },
      "readonly": true,
      "title": "References related to this resource",
      "type": "array"
    },
    "_schema": {
      "readonly": true,
      "title": "Schema for this resource",
      "type": "string"
    },
    "_self": {
      "$ref": "SelfResourceLink",
      "readonly": true,
      "title": "Link to this resource"
    },
    "bms_external_id": {
      "description": "External ID of the bare metal server to which this interface belongs.",
      "required": false,
      "title": "BMS External ID",
      "type": "string"
    },
    "description": {
      "can_sort": true,
      "maxLength": 1024,
      "title": "Description of this resource",
      "type": "string"
    },
    "display_name": {
      "can_sort": true,
      "description": "Defaults to ID if not set",
      "maxLength": 255,
      "title": "Identifier to use when displaying entity in logs or GUI",
      "type": "string"
    },
    "external_id": {
      "description": "External id to identify the bare metal server interface in the NSX.",
      "required": true,
      "title": "External id",
      "type": "string"
    },
    "ip_addresses": {
      "description": "IP Addresses of the bare metal server interface",
      "items": {
        "type": "string"
      },
      "required": false,
      "title": "IP address",
      "type": "array"
    },
    "is_mgmt_interface": {
      "description": "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.",
      "required": false,
      "title": "Flag for management interface",
      "type": "boolean"
    },
    "mac_address": {
      "description": "MAC address of the bare metal server interface.",
      "required": false,
      "title": "MAC address",
      "type": "string"
    },
    "resource_type": {
      "description": "The type of this resource.",
      "readonly": false,
      "required": true,
      "type": "string"
    },
    "scope": {
      "description": "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.",
      "items": {
        "$ref": "DiscoveredResourceScope"
      },
      "readonly": false,
      "required": false,
      "title": "List of scopes for discovered resource",
      "type": "array"
    },
    "source_id": {
      "description": "Id of the bare metal controller (BMC) which is discovering Bare Metal Server.",
      "required": false,
      "title": "Source id",
      "type": "string"
    },
    "state": {
      "description": "State of the the bare metal server interface.",
      "enum": [
        "INVALID",
        "UNKNOWN",
        "UP",
        "DOWN"
      ],
      "required": false,
      "title": "State",
      "type": "string"
    },
    "tags": {
      "items": {
        "$ref": "Tag"
      },
      "maxItems": 30,
      "title": "Opaque identifiers meaningful to the API user",
      "type": "array"
    }
  },
  "type": "object"
}