HP OneView REST API Reference

fc-networks
fc-networks.html[10/17/2013 10:35:33 AM]
Updated: October 16, 2013 4:31
MDT
API Specifications Create Read Update Delete
/rest/fc-networks POST GET
/rest/fc-networks/schema GET
/rest/fc-networks/{id} GET PUT DELETE
Resource Model
FcNetwork
FcNetworkList
HP OneView REST API Reference
fc-networks
The Fibre Channel networks resource provides REST APIs for managing Fibre Channel Networks. A Fibre Channel (FC)
network is a shared resource and available to any logical interconnect. The logical interconnect assigns the FC network to
an uplink set. FC networks are not switched across stacking links within the logical interconnect. Therefore, an FC network
cannot be used for local access within the logical interconnect, although it can be used for external access from the logical
interconnect to the data center FC fabric. Each FC network directly associates with a connection template. The connection
template determines the bandwidth available to network connections. The FC network may be designated as either
'FabricAttach' or 'DirectAttach'. A FabricAttach FC network attaches to a standard FC fabric. A DirectAttach FC network
attaches directly to a target storage device (also called a "flat SAN"), such as a 3PAR disk array. The FC network supports
both automated and manual login redistribution. 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/fc-networks
Method API
GET Gets a paginated collection of Fibre Channel networks. The collection is 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