Network Objects

Network objects are used to collect information about network subnets that can be used for deploying compute nodes.

When issuing requests, the UID field in the URL can be either the actual UID of the object or the name of the object as given in the "name" field. For Networks the name field is optional, so using the UID may be the most reliable approach.

Data Fields

Network objects have several fields:

first_ip
     Required: The starting IP address for this network

ip_count
     Required: (Integer) number of IP addresses that may be assigned on this subnet

mask_bits
     Required: (Integer) number of bits for the network mask

name
     Optional: The name of the user on the underlying system

description
     Optional: A text string with descriptive information

first_index
     Optional: (Integer) number for the first index of the nodes in this network

router_ip
     Optional: The IP address for the router on this network

gateway_ip
     Optional: The IP address for the gateway on this network

domain
     Optional: The domain name to be set for this network

node_iface
     Optional: Network interface used during booting

Additional Endpoints

There are several additional endpoints for networks:

GET /nets/byiface/<PART>
This endpoint is deprecated and will be removed in a future release; returns a
     JSON object with a list of networks that reference the interface name, NAME;
     full or partial matches are returned

GET /nets/byname/<NAME>
     Returns a JSON object with a list of networks that reference the network name, NAME;
     full or partial matches are returned

GET /nets/byip/<IPADDR>
     Returns a JSON object with a list of networks that reference the partial or full
     IP address, IPADDR

GET /nets/bykey/<PART>
     Returns a JSON object with a list of networks that reference the partial or full
     UID, PART