NSX-T Data Center REST API

NicInfo (type)

{
  "description": "Information of a network interface present on the partner appliance that needs to be configured by the NSX Manager.", 
  "id": "NicInfo", 
  "module_id": "ServiceInsertionCommonTypes", 
  "properties": {
    "gateway_address": {
      "description": "Gateway address associated with the NIC metadata.", 
      "readonly": false, 
      "required": false, 
      "title": "Gateway address", 
      "type": "string"
    }, 
    "ip_address": {
      "description": "IP address associated with the NIC metadata. Required only when assigning IP statically for a deployment that is for a single VM instance.", 
      "readonly": false, 
      "required": false, 
      "title": "IP address", 
      "type": "string"
    }, 
    "ip_allocation_type": {
      "description": "IP allocation type with values STATIC, DHCP, or NONE indicating that IP address is not required.", 
      "enum": [
        "STATIC", 
        "DHCP", 
        "NONE"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "IP allocation type", 
      "type": "string"
    }, 
    "ip_pool_id": {
      "description": "If the nic should get IP using a static IP pool then IP pool id should be provided here.", 
      "readonly": false, 
      "required": false, 
      "title": "Static IP Pool Id", 
      "type": "string"
    }, 
    "network_id": {
      "description": "Network Id associated with the NIC metadata. It can be a moref, or a logical switch ID. If it is to be taken from 'Agent VM Settings', then it should be empty.", 
      "readonly": false, 
      "required": false, 
      "title": "Network Id", 
      "type": "string"
    }, 
    "nic_metadata": {
      "$ref": "NicMetadata, 
      "description": "NIC metadata information.", 
      "readonly": true, 
      "required": true, 
      "title": "NIC metadata"
    }, 
    "subnet_mask": {
      "description": "Subnet mask associated with the NIC metadata.", 
      "readonly": false, 
      "required": false, 
      "title": "Subnet mask", 
      "type": "string"
    }
  }, 
  "title": "NIC information", 
  "type": "object"
}