HP OneView REST API Reference

uplink-sets
uplink-sets.html[10/17/2013 10:35:32 AM]
Updated: October 16, 2013 4:31
MDT
API Specifications Create Read Update Delete
/rest/uplink-sets POST GET
/rest/uplink-sets/schema GET
/rest/uplink-sets/{id} GET PUT DELETE
Resource Model
UplinkSet
NetworkReference
UplinkSetCollection
HP OneView REST API Reference
uplink-sets
This resource manages uplink sets. Interconnect uplinks are grouped into an uplink set and managed as a unit, with an assigned set of one or more
networks. The traffic carried over the uplinks is determined by the network assignment of the uplink set. Uplink sets can support either Ethernet or Fibre
Channel networks. Depending on the type of the assigned networks, uplink sets can support both an automatic and a selective failover or distribution
strategy. The uplink port state is monitored, which contributes to the overall reachability status of the assigned networks. For each port belonging to the
uplink set, the assigned port speed can be monitored. The REST API (POST, GET, UPDATE, DELETE) 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/uplink-sets
Method API
POST Creates an uplink set.
Parameter Attributes Description
Request
Header
Attributes Description
REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the current release, this must be
set to "X-API-Version:3"
Request
Body
Attributes Description
UplinkSet Required The uplink set to be created
Response Description
TaskResourceV2 An object that can be used to track the progress of the create uplink
set operation to completion
Response Codes
REST API Response Codes
Examples
Create an uplink set using the supplied resource's information:
POST https://{appl}/rest/uplink-sets
GET Gets a paginated list of uplink 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,