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

NAME

Brocade::BSC::NetconfNode

DESCRIPTION

A Brocade::BSC::NetconfNode object is used to model, query, and configure netconf devices via Brocade's OpenDaylight-based Software-Defined Networking controller.

METHODS

new

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

### parameters:
#   + cfgfile       - path to YAML configuration file specifying node attributes
#   + ctrl          - reference to Brocade::BSC controller object (required)
#   + name          - name of controlled netconf node
#   + ipAddr        - IP address of netconf node
#   + portNum       - TCP port for node's NETCONF interface
#   + tcpOnly       - boolean
#   + adminName     - username
#   + adminPassword - password
#
### YAML configuration file labels and default values
#
#   parameter hash | YAML label  | default value
#   -------------- | ----------- | -------------
#   name           | nodeName    |
#   ipAddr         | nodeIpAddr  |
#   portNum        | nodePortNum | 830
#   tcpOnly        |             | 0
#   adminName      | nodeUname   | admin
#   adminPassword  | nodePswd    | admin
#   timeout        | timeout     | 5

Returns new Brocade::BSC::NetconfNode object.

as_json
# Returns   : Returns pretty-printed JSON string representing netconf node.

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.