README.md in oxidized-0.14.3 vs README.md in oxidized-0.15.0
- old
+ new
@@ -18,17 +18,18 @@
#### Index
1. [Supported OS Types](#supported-os-types)
2. [Installation](#installation)
* [Debian](#debian)
- * [CentOS, Oracle Linux, Red Hat Linux version 6](#centos-oracle-linux-red-hat-linux-version 6)
+ * [CentOS, Oracle Linux, Red Hat Linux](#centos-oracle-linux-red-hat-linux)
3. [Initial Configuration](#configuration)
4. [Installing Ruby 2.1.2 using RVM](#installing-ruby-2.1.2-using-rvm)
5. [Running with Docker](#running-with-docker)
6. [Cookbook](#cookbook)
* [Debugging](#debugging)
* [Privileged mode](#privileged-mode)
+ * [Disabling SSH exec channels](#disabling-ssh-exec-channels)
* [Source: CSV](#source-csv)
* [Source: SQLite](#source-sqlite)
* [Source: HTTP](#source-http)
* [Output: GIT](#output-git)
* [Output: HTTP](#output-http)
@@ -60,10 +61,11 @@
* Brocade
* FabricOS
* Ironware
* NOS (Network Operating System)
* Vyatta
+ * 6910
* Ciena
* SOAS
* Cisco
* AireOS
* ASA
@@ -72,10 +74,13 @@
* IOSXR
* NXOS
* SMB (Nikola series)
* Citrix
* NetScaler (Virtual Applicance)
+ * Coriant (former Tellabs)
+ * TMOS (8800)
+ * 8600
* Cumulus
* Linux
* DataCom
* DmSwitch 3000
* DELL
@@ -99,10 +104,12 @@
* Huawei
* VRP
* Juniper
* JunOS
* ScreenOS (Netscreen)
+ * Mellanox
+ * MLNX-OS
* Mikrotik
* RouterOS
* Motorola
* RFS
* MRV
@@ -111,16 +118,20 @@
* WISP Switch (As Netonix)
* Opengear
* Opengear
* Palo Alto
* PANOS
+ * Quanta
+ * Quanta / VxWorks 6.6 (1.1.0.8)
* Supermicro
* Supermicro
* Ubiquiti
* AirOS
* Edgeos
* EdgeSwitch
+ * Watchguard
+ * Fireware OS
* Zyxel
* ZyNOS
# Installation
@@ -131,26 +142,40 @@
apt-get install ruby ruby-dev libsqlite3-dev libssl-dev pkg-config cmake libssh2-1-dev
gem install oxidized
gem install oxidized-script oxidized-web # if you don't install oxidized-web, make sure you remove "rest" from your config
```
-## CentOS, Oracle Linux, Red Hat Linux version 6
-Install Ruby 1.9.3 or greater (for Ruby 2.1.2 installation instructions see "Installing Ruby 2.1.2 using RVM"), then install Oxidized dependencies
+## CentOS, Oracle Linux, Red Hat Linux
+On CentOS 6 / RHEL 6, install Ruby 1.9.3 or greater (for Ruby 2.1.2 installation instructions see "Installing Ruby 2.1.2 using RVM"), then install Oxidized dependencies
```shell
yum install cmake sqlite-devel openssl-devel libssh2-devel
```
-Now lets install oxidized via Rubygems:
+RHEL 7 / CentOS 7 will work out of the box with the following package list:
+
```shell
+yum install cmake sqlite-devel openssl-devel libssh2-devel ruby gcc ruby-devel
+```
+
+Now let's install oxidized via Rubygems:
+```shell
gem install oxidized
gem install oxidized-script oxidized-web
```
# Configuration
Oxidized configuration is in YAML format. Configuration files are subsequently sourced from ```/etc/oxidized/config``` then ```~/.config/oxidized/config```. The hashes will be merged, this might be useful for storing source information in a system wide file and user specific configuration in the home directory (to only include a staff specific username and password). Eg. if many users are using ```oxs```, see [Oxidized::Script](https://github.com/ytti/oxidized-script).
+It is recommended practice to run Oxidized using its own username. This username can be added using standard command-line tools:
+
+```
+useradd oxidized
+```
+
+It is recommended not to run Oxidized as root.
+
To initialize a default configuration in your home directory ```~/.config/oxidized/config```, simply run ```oxidized``` once. If you don't further configure anything from the output and source sections, it'll extend the examples on a subsequent ```oxidized``` execution. This is useful to see what options for a specific source or output backend are available.
You can set the env variable `OXIDIZED_HOME` to change its home directory.
```
@@ -314,10 +339,20 @@
```
The above strips out snmp community strings from your saved configs.
**NOTE:** Removing secrets reduces the usefulness as a full configuration backup, but it may make sharing configs easier.
+### Disabling SSH exec channels
+
+Oxidized uses exec channels to make information extraction simpler, but there are some situations where this doesn't work well, e.g. configuring devices. This feature can be turned off by setting the ```ssh_no_exec```
+variable.
+
+```
+vars:
+ ssh_no_exec: true
+```
+
### Source: CSV
One line per device, colon seperated.
```
@@ -549,9 +584,10 @@
prompt: !ruby/regexp /^([\w.@-]+[#>]\s?)$/
vars:
enable: S3cr3tx
groups: {}
rest: 127.0.0.1:8888
+pid: ~/.config/oxidized/oxidized.pid
input:
default: ssh, telnet
debug: false
ssh:
secure: false