HP OneView REST API Reference

interconnects
interconnects.html[10/17/2013 10:35:37 AM]
Updated: October 16, 2013 4:31
MDT
API Specifications Create Read Update Delete
/rest/interconnects GET
/rest/interconnects/schema GET
/rest/interconnects/{id} GET
/rest/interconnects/{id}/configuration PUT
/rest/interconnects/{id}/ports GET PUT
/rest/interconnects/{id}/ports/{portId} GET
/rest/interconnects/{id}/statistics GET
/rest/interconnects/{id}/statistics/reset PUT
/rest/interconnects/{id}/statistics/{portName} GET
/rest/interconnects/{id}/statistics/{portName}/subport/{subPortNumber} GET
/rest/interconnects/{interconnectsId}/nameServers GET
Resource Model
Interconnect
InterconnectsStatistics
NameServer
Port
PortCollection
UplinkPortCollection
PortStatistics
SubportStatistics
DCCVlan
PluggableModuleInformation
DesiredFirmware
InstalledFirmware
SwitchDumpDataInfo
SwitchDumpGenerationInfo
SwitchFrmUpgRequest
InterconnectCollection
UplinkPort
HP OneView REST API Reference
interconnects
This resource provides APIs for managing interconnects. Interconnects are centrally managed by their containing logical interconnect. The interconnect provides a
physical view of detailed downlink and uplink port state and configuration, including the current link state, speed, port role (uplink, downlink, or stacking), current
pluggable media, power state, and immediate connected neighbor. Individual ports may be administratively enabled or disabled. 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} can be
retrieved from https://{appl}/rest/login-sessions.
URI: /rest/interconnects
Method API
GET Gets a paginated collection of interconnects that includes the ports. Note: in order to avoid a timeout on busy systems, the recommended
maximum value of count is 2.
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." It is recommended that you specify
a count of no more than 2 due to resource constraints in busy systems. If a count is specified, the API
attempts to return the specified number of resources. The results will include the total number of
resources that match the filter or query, the actual count returned, and the URIs to go to the next and/or
previous page. 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. Using the count and start parameters enables
retrieval of the specified number of pages.
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"
Response Description
InterconnectCollection A paginated collection of interconnect resources