HP OneView REST API Reference

connections
connections.html[10/17/2013 10:35:16 AM]
Updated: October 16, 2013 4:33
MDT
API Specifications Create Read Update Delete
/rest/connections GET
/rest/connections/schema GET
/rest/connections/{id} GET
Resource Model
ConnectionInstance
ConnectionInformationCollection
HP OneView REST API Reference
connections
The connections resource manages connections between a source (for example a server) and one or more networks. A
'network' may be an Ethernet network, a FibreChannel network, or a NetworkSet. Each connection is associated with a
lifecycle state: Reserved, Deployed, Active, Failed, or Released. The REST API (POST, GET, UPDATE, DELETE)
supports an 'accept-language' in the request header which defaults to 'en_US'. An 'auth:{token}' in the request header is
required. The {token} may be retrieved from https://{appl}/rest/login-sessions.
URI: /rest/connections
Method API
GET Gets a paginated collection of connections based on optional sorting and filtering, and constrained
by start and count parameters. Supported filters: /rest/connections?filter="interconnectUri=xxxx"
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.
query Experimental This parameter is experimental for this release: