Brocade::BSC - Configure and query the Brocade SDN controller.
Version 1.0.4
A Brocade::BSC object is used to model, query, and configure Brocade's OpenDaylight-based Software-Defined Networking controller.
Most API methods return a duple: a Brocade::BSC::Status object, and a reference to a data structure with the requested information. Status should always be verified before attempting to dereference the second return value.
Creates a new Brocade::BSC object and populates fields with values from argument hash, if present, or YAML configuration file.
### parameters: # + cfgfile - path to YAML configuration file specifying controller attributes # + ipAddr - IP address of controller # + portNum - TCP port for controller's REST interface # + adminName - username # + adminPassword - password # + timeout - for HTTP requests, in seconds # ### YAML configuration file labels and default values # # parameter hash | YAML label | default value # -------------- | ----------- | ------------- # ipAddr | ctrlIpAddr | 127.0.0.1 # portNum | ctrlPortNum | 8181 # adminName | ctrlUname | admin # adminPassword | ctrlPswd | admin # timeout | timeout | 5
Returns new Brocade::BSC object.
# Returns pretty-printed JSON string representing BSC object.
# Returns : BSC::Status # : reference to an array of node names
# Parameter : node name (string, required) # Returns : BSC::Status # : array reference containing node info
# Parameter : node name (string, required) # Returns : BSC::Status - NODE_CONFIGURED or NODE_NOT_FOUND
# Parameter : node name (string, required) # Returns : BSC::Status - NODE_CONNECTED or NODE_DISCONNECTED
# Returns : BSC::Status # : array reference - list of node identifiers
# Returns : BSC::Status # : reference to array of hashes: # { id => nodename, # connected => boolean }
# Parameters: node name (string, required) # Returns : BSC::Status # : array reference - supported schemas on node
# Parameters: node name # : YANG schema ID # : YANG schema version # Returns : BSC::Status # : requested YANG schema as formatted JSON
# Parameters: node name # Returns : BSC::Status # : hash reference - operations supported by specified node
# Returns : BSC::Status # : array reference - hashes of module state
# Parameter : module type # : module name # Returns : BSC::Status # : array reference - hash of module state
# Parameters: node name # Returns : BSC::Status # : hash reference - session listing on specified node
# Parameters: # Returns : BSC::Status # : hash reference - streams info
# Parameters: # Returns : BSC::Status # : array reference ~ name/provider pairs
# Parameters: node name # Returns : BSC::Status # : array reference ~ name/provider pairs
Add a mount point on controller for specified node.
# Parameters: node name # Returns : BSC::Status
# Parameters: node name # Returns : BSC::Status # :
# Parameters: node name # Returns : base restconf URL for configuration of mounted netconf node
# Parameters: node name # Returns : base restconf URL for operational status of mounted netconf node
# Parameters: node name # Returns : base restconf URL for node, operational status
# Parameters: node name # Returns : base restconf URL for node, configuration
# Returns : BSC::Status # : array reference - node names
<pruiklw at cpan.org>
Please report any bugs or feature requests to bug-brocade-bsc at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Brocade-BSC. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
bug-brocade-bsc at rt.cpan.org
You can find documentation for this module with the perldoc command.
perldoc Brocade::BSC
You can also look for information at:
RT: CPAN's request tracker (report bugs here)
http://rt.cpan.org/NoAuth/Bugs.html?Dist=Brocade-BSC
Brocade::BSC is entirely based on pybvc created by Sergei Garbuzov.
Copyright (c) 2015, BROCADE COMMUNICATIONS SYSTEMS, INC
All rights reserved.
To install Brocade::BSC, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Brocade::BSC
CPAN shell
perl -MCPAN -e shell install Brocade::BSC
For more information on module installation, please visit the detailed CPAN module installation guide.