HP OneView REST API Reference

logical-interconnect-groups
logical-interconnect-groups.html[10/17/2013 10:35:26 AM]
Updated: October 16, 2013 4:31
MDT
API Specifications Create Read Update Delete
/rest/logical-interconnect-groups POST GET
/rest/logical-interconnect-groups/defaultSettings GET
/rest/logical-interconnect-groups/schema GET
/rest/logical-interconnect-groups/{id} GET PUT DELETE
/rest/logical-interconnect-groups/{id}/settings/{settingsId} GET
Resource Model
LogicalInterconnectGroup
LogicalInterconnectGroupCollection
InterconnectSettings
SnmpConfiguration
SnmpAccessIp
TrapDestination
HP OneView REST API Reference
logical-interconnect-groups
Manages logical interconnect groups. A logical interconnect group serves as a structural reference when building a logical interconnect. All of the configuration constructs of a logical interconnect are present in the logical
interconnect group. The logical interconnect group serves as the initial and ongoing reference for the structure of a logical interconnect. The logical interconnect group defines the centralized source for the configuration of
interconnect firmware, telemetry, and SNMP, including common settings such as IGMP snooping, MAC cache failover, and loop protection. After being constructed from a logical interconnect group, a logical interconnect
continues to maintain an association to its logical interconnect group. Any drift in configuration consistency between the logical interconnect group and logical interconnect(s) is monitored and made visible on both the logical
interconnect group and the associated logical interconnect(s). The logical interconnect group defines the aggregation of one or more interconnect locations with a common configuration, providing L2/L3 Ethernet and Fibre
Channel connectivity to a set of downlink locations and uplink locations. Downlinks provide connectivity to servers. Uplinks provide connectivity to data center interconnect infrastructure associated network resources. Uplink
locations are grouped into uplink sets and managed as a unit with an assigned set of one or more networks. The network assignment of the uplink set determines the traffic carried over the uplink locations. Networks are
also assigned to connections, and connections are assigned to downlinks. The networks assigned to a connection determine the traffic that will be carried over a downlink. 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/logical-interconnect-groups
Method API
GET Gets a list of logical interconnect groups 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 generally functional when used in simple cases, restrictions might be noted in the
implementation description.
A general filter/query string that narrows the list of resources returned by a multi-resource GET (read) request and DELETE (delete)
request. The default is no filter (all resources are returned).
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"