HP OneView REST API Reference

logical-downlinks
logical-downlinks.html[10/17/2013 10:35:31 AM]
Updated: October 16, 2013 4:31
MDT
API Specifications Create Read Update Delete
/rest/logical-downlinks GET
/rest/logical-downlinks/schema GET
/rest/logical-downlinks/withoutEthernet GET
/rest/logical-downlinks/{id} GET
/rest/logical-downlinks/{id}/withoutEthernet GET
Resource Model
LogicalDownlink
LogicalDownlinkCollection
HP OneView REST API Reference
logical-downlinks
This resource manages logical downlinks. A logical downlink represents the set of networks and downlink capabilities
available for connections at a specific interconnect map location. If multiple interconnect map locations support the same
set of networks and downlink capabilities, they all refer to the same logical downlink. The REST API (GET) supports an
'accept-language' in the request header. The default 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/logical-downlinks
Method API
GET Gets a list of logical downlinks 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.
filter
Experimental This parameter is experimental for this release: While