HP OneView REST API Reference

network-sets
network-sets.html[10/17/2013 10:35:34 AM]
Updated: October 16, 2013 4:31
MDT
API Specifications Create Read Update Delete
/rest/network-sets POST GET
/rest/network-sets/schema GET
/rest/network-sets/withoutEthernet GET
/rest/network-sets/{id} GET PUT DELETE
/rest/network-sets/{id}/withoutEthernet GET
Resource Model
NetworkSet
NetworkSetList
HP OneView REST API Reference
network-sets
This resource manages network sets. A network set is a group of Ethernet L2/L3 networks assigned to one or more
connections, giving each single connection access to multiple networks. A network set is a shared resource available to all
logical interconnects. It is directly associated with a connection template governing the bandwidth permitted to connections
that use the network set. Within a network set, all network frames are exchanged over the connection with their 802.1Q
VLAN ID in place (in other words, network traffic is tagged with its VLAN ID). However, there is one exception to this rule:
one network within the network set can be designated as the 'nativeNetwork'. The 802.1Q VLAN ID is removed from
'nativeNetwork' traffic egressing the interconnect downlink (in other words, 'nativeNetwork' traffic is untagged). This allows a
single connection to support multiple tagged networks plus a single untagged network over the same downlink. The REST
API (POST, GET, UPDATE, DELETE) supports an 'accept-language' in the request header. The defaults is 'en_US'. An
'auth:{token}' in the request header is required. The {token} may be retrieved from https://{appl}/rest/login-sessions.
URI: /rest/network-sets
Method API
GET Gets a list of network sets based on optional sorting and filtering, and constrained by start and
count parameters.
Parameter Attributes Description
start Optional The 0-based index of the first resource to return (start=0 starts
with the first available resource). If the specified count does not
return all resources within the maximum allowed time (see count),
use the start parameter to view additional resource pages. The
default value for start is 0 (first available resource).
count Optional Optional parameter that specifies the number of resources to return
from each API invocation. The number of resources returned on
each call is referred to as a page. If you specify a count, the API
attempts to return the specified number of resources, however this
may be limited due to response time constraints and/or actual
number of resources available to return. The results include the total
number of resources that match the filter or query, the actual
count returned, and the URIs to go to the next page, previous page,
or both. If necessary, you can make several requests using the URI
for the next or previous page (or different start parameters) to get
the desired count.
sort Optional The sort order of the returned data set. By default, the sort order is
based on the create time, with the oldest entry first.