index.rst

Riverbed SteelScript for Python

SteelScript is a collection of libraries and scripts in Python for interacting with Riverbed solutions and appliances, and other network infrastructure devices. SteelScript is provided by Riverbed as an open source project on GitHub

Tip

Go to SteelScript on GitHub for quick starts and more about the latest SteelScript

Warning

This documentation has been created for SteelScript 2.0 at the time of Python 2 and 3.8 and has not been updated and reviewed for a while. For latest information about SteelScript that works in containers, on Linux/Mac and Windows, supports Python 3.12+, notebooks and more, please refer to SteelScript on GitHub

<<outdated>> SteelScript 2.0 for Python 2/3.8 <<outdated>>

Installing

If you already have pip, just run the following (in a virtualenv):

pip install steelscript
steel install

Not sure about pip, but you know you have Python?

1. Download :download:`steel_bootstrap.py`

2. Run it (in a virtualenv):

   python steel_bootstrap.py install
   

Adding a module with steel command

The SteelScript SteelHead offers a set of interfaces to control and work with a SteelHead appliance. It comes pre-configured with a couple of example scripts showing how to interact with a SteelHead appliance using interfaces provided in this package.

Once you have the base steelscript package installed, getting started is just one command away:

steel install --steelhead

For more details, see the :doc:`doc of the steelscript module for SteelHead <steelhead/overview>`.

Documentation

• :doc:`toc`
• :doc:`Installation <install/toc>`
  • :doc:`Core Install Linux / Mac <install/linuxmac>`
  • :doc:`Core Install Windows <install/windows>`
  • :doc:`Install SteelScript SteelHead <install/steelhead>`
• :doc:`steel`
• Tutorials
  • :doc:`netprofiler/tutorial`
  • :doc:`appresponse/tutorial`
  • :doc:`scc/tutorial`
• Device modules
  • :doc:`netprofiler/overview`
  • :doc:`appresponse/overview`
  • :doc:`steelhead/overview`
  • :doc:`scc/overview`
• Library modules
  • :doc:`common/overview`
  • :doc:`cmdline/overview`

License

This Riverbed SteelScript for Python documentation is provided "AS IS" and without any warranty or indemnification. Any sample code or scripts included in the documentation are licensed under the terms and conditions of the MIT License. See the :doc:`license` page for more information.

.. toctree::
   :hidden:
   :numbered:
   :maxdepth: 3

   install/toc
   steel
   common/toc
   netprofiler/toc
   appresponse/toc
   steelhead/toc
   scc/toc
   cmdline/toc