OpenFlow REST API¶
-
class
hpsdnclient.of.
OfMixin
(controller, restclient)¶ OpenFlow REST API Methods
This class contains methods that call the OpenFlow REST API on the HP VAN SDN Controller
- Topology Service
- Node Service
- Link Service
- Path Planner
- Path Diagnostics Service
-
add_flows
(dpid, flows)¶ Add a flow, or flows to the selected DPID
Parameters: - dpid (str) – The datapath ID
- hpsdnclient.datatypes.Flow flows (list,) – The flow or flows to add
-
add_group
(dpid, group)¶ Create a group
Parameters: - dpid (str) – The datapath ID
- group (hpsdnclient.datatypes.Group) – The group to add
-
add_meter
(dpid, meter)¶ Add a new meter to the supplied DPID
Parameters: - dpid (str) –
- meter (hpsdnclient.datatypes.Meter) – The new Meter object
-
delete_flows
(dpid, flows)¶ Delete flow, or flows from the specified DPID
Parameters: - dpid (str) – The datapath ID
- hpsdnclient.datatypes.Flow flows (list,) – The flow or flows to delete
-
delete_groups
(dpid, group_id)¶ Delete a group
Parameters: - dpid (str) – The datapath ID
- group_id (str) – The group ID to delete
-
delete_meter
(dpid, meter_id)¶ Delete a meter
Parameters: - dpid (str) – The datapath ID
- meter_id (str) – The meter ID to be deleted
-
get_datapath_detail
(dpid)¶ Get detailed information for a datapath.
Parameters: dpid (str) – The datapath ID Returns: Datatpath details Return type: hpsdnclient.datatypes.Datapath
-
get_datapaths
()¶ List all datapaths that are managed by this controller.
Returns: A list of Datapaths Return type: list
-
get_flows
(dpid)¶ Gets a list of flows on the supplied DPID
Parameters: dpid (str) – The datapath ID Returns: List of flows Return type: list
-
get_group_details
(dpid, group_id)¶ Get group details
Parameters: - dpid (str) – The datapath ID
- group_id (str) – The group ID
Returns: Group details
Return type:
-
get_group_features
(dpid)¶ Get datapath group features
Parameters: dpid (str) – The Datapath ID Returns: Group Features Return type: hpsdnclient.datatypes.GroupFeatures
-
get_group_stats
(dpid, group_id=None)¶ List group statistics
Parameters: - dpid (str) – Filter by Datapath ID
- group_id – Filter by Group ID
Returns: Group statistics
Return type:
-
get_groups
(dpid)¶ Get a list of groups created on the DPID
Parameters: dpid (str) – The datapath ID Returns: List of groups Return type: list
-
get_meter_details
(dpid, meter_id)¶ Get detailed meter information
Parameters: - dpid (str) – The datapath ID
- meter_id (str) – The meter ID
Returns: Meter details
Return type:
-
get_meter_features
(dpid)¶ Get meter features for the provided Datapath ID
Parameters: dpid (str) – The Datapath ID Returns: Meter Features Return type: hpsdnclient.datatypes.MeterFeatures
-
get_meter_stats
(dpid, meter_id)¶ List meter statistics for
Parameters: - dpid (str) – The Datapath ID
- meter_id (str) – The Meter ID
Returns: Meter statistics
Return type:
-
get_meters
(dpid)¶ List all meters configured on the supplied DPID
Parameters: dpid (str) – The datapath ID Returns: A list of meters Return type: list
-
get_port_detail
(dpid, port_id)¶ Gets detailed port information for the specified port
Parameters: - dpid (str) – The datapath ID
- port_id (str) – The port ID
Returns: Port details
Return type:
-
get_port_stats
(dpid, port_id=None)¶ List all port statistics for a given datapath or for a given datapath and port number
Parameters: - dpid (str) – Filter by Datapath ID
- port_id (str) – Filter by Port ID
Returns: Statistics for Port
Return type:
-
get_ports
(dpid)¶ Gets a list of ports from the specified DPID
Parameters: dpid (str) – The datapath ID Returns: List of ports Return type: list
-
get_stats
()¶ List controller statistics for all controllers that are part of this controller’s team.
Returns: List of statistics Return type: hpsdnclient.datatypes.Stats
-
update_flows
(dpid, flows)¶ Update a flow, or flows at the selected DPID
Parameters: - dpid (str) – The datapath ID
- hpsdnclient.datatypes.Flow flows (list,) – The flow or flows to update
-
update_group
(dpid, group_id, group)¶ Update a group
Parameters: - dpid (str) – The datapath ID
- group (hpsdnclient.datatypes.Group) – The group to add
-
update_meter
(dpid, meter_id, meter)¶ Update the specified meter
Parameters: - dpid (str) – The datapath ID
- meter_id (str) – The meter ID
- meter (hpsdnclient.datatypes.Meter) – The meter