HP OneView REST API Reference

ethernet-networks
ethernet-networks.html[10/17/2013 10:35:33 AM]
Updated: October 16, 2013 4:30
MDT
API Specifications Create Read Update Delete
/rest/ethernet-networks POST GET
/rest/ethernet-networks/schema GET
/rest/ethernet-networks/{id} GET PUT DELETE
Resource Model
Network
NetworkList
HP OneView REST API Reference
ethernet-networks
The Ethernet networks resource provides APIs for managing Ethernet Networks. An Ethernet network is an L2/L3 network
supporting 802.1Q/VLAN encapsulation. It is a shared resource and available to all logical interconnects. It is directly
associated with a connection template governing the bandwidth permitted to connections which use the network. The
network may be public (meaning that servers associated to the logical interconnect may communicate with each other
across the network) or private (meaning that servers associated with the logical interconnect may not communicate with
each other across the network). An Ethernet network supports a link detection capability which, when enabled, will monitor
the link state of all uplinks within a logical interconnect which carry the network. If all of the uplinks lose their connection to
an external interconnect, the server downlinks connected to the network are forced down. This triggers the NIC teaming
driver running on the server to failover to an alternate path. 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/ethernet-networks
Method API
POST Creates an Ethernet network.
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
Network Required The Ethernet network to add
Response Description
TaskResourceV2 An object that can be used to track the create
Ethernet network operation to completion
Response Codes
REST API Response Codes
Examples
Create an Ethernet network with the name "vlan10":
POST https://{appl}/rest/ethernet-networks
Request Body:
{