HP OneView REST API Reference

interconnects
interconnects.html[10/17/2013 10:35:37 AM]
PUT Applies or re-applies the current interconnect configuration.
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"
Response Description
TaskResourceV2 An object that can be used to track the progress of the configuration operation to
completion
Response Codes
REST API Response Codes
Examples
Apply the current configuration to the interconnect that
matches ID 9b8f7ec0-52b3-475e-84f4-c4eac51c2c20:
PUT https://{appl}/rest/interconnects/9b8f7ec0-52b3-475e-84f4-c4eac51c2c20/configuration
URI: /rest/interconnects/{id}/ports
Method API
GET Gets all interconnect ports.
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.
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
PortCollection A paginated collection of port resources
Response Codes
REST API Response Codes
Examples
Get all ports on the interconnect that matches ID 9b8f7ec0-52b3-475e-84f4-c4eac51c2c20:
GET https://{appl}/rest/interconnects/9b8f7ec0-52b3-475e-84f4-c4eac51c2c20/ports
PUT Updates an interconnect port.
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
Port Required The interconnect port to be updated
Response Description
TaskResourceV2 An object that can be used to track the progress of the update operation to
completion