Table of Contents - lenovo-rbapi-0.0.5 Documentation
Pages
-
LICENSE
- Copyright © 2017, Lenovo. 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
-
README
- Lenovo CNOS Ruby API Library
- Overview
- Requirements
- CNOS Ruby APIs
- Using the API
- Switch Configutation file
- transport (HTTP/HTTPs)
- HTTP(s) port number (8090 - HTTP, 443 - HTTPs)
- Switch IP address
- Switch Credentials
- Creating connection and sending configurations
- import the libraries
- create connection to the node using the configuration file
- transport (HTTP/HTTPs)
- HTTP(s) port number (8090 - HTTP, 443 - HTTPs)
- Switch IP address
- Switch Credentials
- Use VLAN APIs to retrieve VLAN information
- Use VLAN APIs to create/update and delete VLANs
Classes and Modules
- Arp
- Connect
- Igmp
- Ipintf
- Lacp
- Lag
- LenovoGem
- LenovoGem::Cnos
- Lldp
- Mstp
- Object
- Rest
- Stp
- System
- Telemetry
- Vlag
- Vlan
- VlanIntf
- Vrrp
Methods
- ::clear_bst_cgsn_ctrs — Telemetry
- ::clear_bst_stats — Telemetry
- ::clear_bst_threshold — Telemetry
- ::create_lag — Lag
- ::create_mstp_inst — Mstp
- ::create_vlag_inst — Vlag
- ::create_vlan — Vlan
- ::create_vrrp_intf — Vrrp
- ::del_mstp_inst — Mstp
- ::del_vrrp_intf_vrid — Vrrp
- ::delete — Rest
- ::delete_lag — Lag
- ::delete_vlag_inst — Vlag
- ::delete_vlan — Vlan
- ::download_boot_img — System
- ::download_sw_config — System
- ::get — Rest
- ::get_all_lag — Lag
- ::get_all_stp — Stp
- ::get_all_vlag — Vlag
- ::get_all_vlan — Vlan
- ::get_all_vlan_intf — VlanIntf
- ::get_arp_intf_prop — Arp
- ::get_arp_prop_all — Arp
- ::get_arp_sys_prop — Arp
- ::get_bst_feature — Telemetry
- ::get_bst_report — Telemetry
- ::get_bst_threshold — Telemetry
- ::get_bst_tracking — Telemetry
- ::get_clock — System
- ::get_device_contact — System
- ::get_device_descr — System
- ::get_global_vlag — Vlag
- ::get_hostname — System
- ::get_igmp_snoop_prop — Igmp
- ::get_igmp_vlan_prop — Igmp
- ::get_ip_prop_all — Ipintf
- ::get_ip_prop_intf — Ipintf
- ::get_lacp — Lacp
- ::get_lag_prop — Lag
- ::get_lldp_all_intf — Lldp
- ::get_lldp_intf — Lldp
- ::get_lldp_intf_neighbor — Lldp
- ::get_lldp_intf_neighbor_all — Lldp
- ::get_lldp_intf_stats — Lldp
- ::get_lldp_prop — Lldp
- ::get_load_balance — Lag
- ::get_mstp_inst — Mstp
- ::get_mstp_inst_all — Mstp
- ::get_mstp_inst_intf — Mstp
- ::get_mstp_sys_prop — Mstp
- ::get_startup_sw — System
- ::get_stp_intf — Stp
- ::get_sys_feature — Telemetry
- ::get_transfer_status — System
- ::get_vlag_conf — Vlag
- ::get_vlag_health — Vlag
- ::get_vlag_inst_confg — Vlag
- ::get_vlag_inst_info — Vlag
- ::get_vlag_isl — Vlag
- ::get_vlan_prop — Vlan
- ::get_vlan_prop_intf — VlanIntf
- ::get_vrrp_intf — Vrrp
- ::get_vrrp_intf_vrid — Vrrp
- ::get_vrrp_prop_all — Vrrp
- ::lenovo? — LenovoGem::Cnos
- ::new — Connect
- ::post — Rest
- ::put — Rest
- ::put_startup_sw — System
- ::reset_switch — System
- ::save_config — System
- ::set_arp_intf_prop — Arp
- ::set_arp_sys_prop — Arp
- ::set_bst_feature — Telemetry
- ::set_bst_threshold — Telemetry
- ::set_bst_tracking — Telemetry
- ::set_clock — System
- ::set_clock_format — System
- ::set_clock_protocol — System
- ::set_clock_summertime — System
- ::set_clock_timezone — System
- ::set_device_contact — System
- ::set_device_descr — System
- ::set_hostname — System
- ::set_igmp_snoop_prop — Igmp
- ::set_igmp_vlan_prop — Igmp
- ::set_sys_feature — Telemetry
- ::update_ip_prop_intf — Ipintf
- ::update_lacp — Lacp
- ::update_lag — Lag
- ::update_lag_load_balance — Lag
- ::update_lldp_intf — Lldp
- ::update_lldp_prop — Lldp
- ::update_mstp_inst — Mstp
- ::update_mstp_inst_intf — Mstp
- ::update_mstp_sys_prop — Mstp
- ::update_stp — Stp
- ::update_vlag_conf — Vlag
- ::update_vlag_health — Vlag
- ::update_vlag_inst — Vlag
- ::update_vlag_isl — Vlag
- ::update_vlan — Vlan
- ::update_vlan_intf — VlanIntf
- ::update_vrrp_intf_vrid — Vrrp
- ::upload_sw_config — System
- ::upload_tech_support — System
- #form_hdr — Object
- #form_url — Object
- #getCookie — Connect
- #getFacts — Connect
- #getHdr — Connect
- #getIp — Connect
- #getPassword — Connect
- #getPort — Connect
- #getTransport — Connect
- #getUser — Connect