/ 
Brocade-BSC-v1.0.0
River stage zero No dependents
/ Brocade::BSC::Openflow::OFSwitch

NAME

Brocade::BSC::Openflow::OFSwitch

DESCRIPTION

Query and configure an OpenFlow-capable switch connected to a BSC controller.

METHODS

new

Creates a new ::OFSwitch object and populates fields with values from argument hash, if present, or YAML configuration file.

as_json
# Returns   : Returns pretty-printed JSON string representing openflow switch.
get_switch_info
# Returns   : BSC::Status
#           : hash ref with basic info on openflow switch
get_features_info
# Returns   : BSC::Status
#           : hash ref of 'switch-features'
get_ports_list
# Returns   : BSC::Status
#           : array ref - list of port numbers
get_ports_brief_info
# Returns   : BSC::Status
#           : array ref - port info hashes
get_port_detail_info
# Parameters: port number
# Returns   : BSC::Status
#           : hash ref - port details
add_modify_flow
# Parameters: flow_entry
# Returns   : BSC::Status - success of operation
delete_flow
# Parameters: table_id
#           : flow_id
# Returns   : BSC::Status - success of operation
delete_flows
# Parameters: table_id - to be cleared of all flows
# Returns   : BSC::Status - success of operation
get_configured_flow
# Parameters: flow table_id
#           : flow_id
# Returns   : BSC::Status
#           : flow as JSON string
get_operational_FlowEntries
# Parameters: table_id  - select table to retrieve
# Returns   : array ref - operational FlowEntry objects
get_configured_FlowEntries
# Parameters: table_id  - select table to retrieve
# Returns   : array ref - configured FlowEntry objects
get_configured_FlowEntry
# Parameters: table_id
#           : flow_id
# Returns   : BSC::Status
#           : FlowEntry object for specified table and flow

LICENCE AND COPYRIGHT

Copyright (c) 2015, BROCADE COMMUNICATIONS SYSTEMS, INC

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.