mikrotik-backup 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gitignore +15 -0
- data/Gemfile +8 -0
- data/LICENSE.txt +22 -0
- data/README.md +73 -0
- data/Rakefile +2 -0
- data/lib/mikrotik-backup.rb +89 -0
- data/lib/mikrotik-backup/version.rb +3 -0
- data/mikrotik-backup.gemspec +23 -0
- metadata +80 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: b288aab7fe3d49ac9b2e68587b8a95a2afea05d0
|
4
|
+
data.tar.gz: dc8e155bb93ce960ca7dff440aa238962a2b6bcc
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: ee55e02d69f097410c1da458a518ef01b49a3bba33836a3a0480ff6d8567e5d20e723069a9e39f31b3b2b685503757e1c7be78cbc18b1acec5d52316b97dd119
|
7
|
+
data.tar.gz: f1df4edbbfad16dda89663c5291cddf09285193508dcb68a37d6b882e3742bb7c944dcfba8826574d7707c422dc781b1000fae6665c0936701d6e5002429e6f0
|
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2015 POS_troi
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,73 @@
|
|
1
|
+
# Mikrotik Backup
|
2
|
+
|
3
|
+
Backup MikroTik configuration using SSH and SFTP.
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
```ruby
|
10
|
+
gem 'mikrotik-backup'
|
11
|
+
```
|
12
|
+
|
13
|
+
And then execute:
|
14
|
+
|
15
|
+
$ bundle
|
16
|
+
|
17
|
+
Or install it yourself as:
|
18
|
+
|
19
|
+
$ gem install mikrotik-backup
|
20
|
+
|
21
|
+
## Usage
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
|
25
|
+
require 'mikrotik-backup'
|
26
|
+
#Config
|
27
|
+
# name - associate host name (and name backup file)
|
28
|
+
# host - host address
|
29
|
+
# user - user name
|
30
|
+
# password - user password
|
31
|
+
# path - local folder for save backup file. "/var/backup/"
|
32
|
+
config = [
|
33
|
+
{name:'Router1', host: '10.10.10.1' , user:'admin' , password:'admin', path:'./'},
|
34
|
+
{name:'Router2', host: '10.10.10.2' ,user:'admin' ,password:'admin', path: './'}
|
35
|
+
]
|
36
|
+
|
37
|
+
|
38
|
+
backup = MTik_backup.new(config)
|
39
|
+
# Logging
|
40
|
+
backup.logger(Logger::ERROR)
|
41
|
+
# Start backup and download
|
42
|
+
backup.backup(true) # <-- "false" - enable only create backup and not download
|
43
|
+
```
|
44
|
+
### Logging
|
45
|
+
```ruby
|
46
|
+
# Logging only Error, out to console
|
47
|
+
logger
|
48
|
+
|
49
|
+
# Full log out to console
|
50
|
+
logger(Logger::DEBUG)
|
51
|
+
|
52
|
+
# Full log out to file
|
53
|
+
logger(Logger::DEBUG,'backup.log')
|
54
|
+
```
|
55
|
+
|
56
|
+
### Only Download backup (previously created)
|
57
|
+
```ruby
|
58
|
+
config = [
|
59
|
+
{name:'Router1', host: '10.10.10.1' , user:'admin' , password:'admin', path:'./'},
|
60
|
+
{name:'Router2', host: '10.10.10.2' ,user:'admin' ,password:'admin', path: './'}
|
61
|
+
]
|
62
|
+
|
63
|
+
backup = MTik_backup.new(config)
|
64
|
+
backup.download
|
65
|
+
```
|
66
|
+
|
67
|
+
## Contributing
|
68
|
+
|
69
|
+
1. Fork it ( https://github.com/POStroi/ruby_mikrotik_backup/fork )
|
70
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
71
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
72
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
73
|
+
5. Create a new Pull Request
|
data/Rakefile
ADDED
@@ -0,0 +1,89 @@
|
|
1
|
+
require "mikrotik-backup/version"
|
2
|
+
require 'net/ssh'
|
3
|
+
require 'net/sftp'
|
4
|
+
# MikroTik backup class
|
5
|
+
class MTik_backup
|
6
|
+
# Initialize
|
7
|
+
def initialize(config)
|
8
|
+
@config = config
|
9
|
+
logger
|
10
|
+
end
|
11
|
+
# Setting for Ruby Logger
|
12
|
+
def logger(log_level = Logger::ERROR,log_file = nil)
|
13
|
+
if log_file.nil?
|
14
|
+
@log = Logger.new(STDOUT)
|
15
|
+
else
|
16
|
+
@log = Logger.new(log_file)
|
17
|
+
end
|
18
|
+
@log.level = log_level
|
19
|
+
@log.formatter = proc { |severity, datetime, progname, msg|
|
20
|
+
"[#{datetime.strftime("%Y-%m-%d %H:%M:%S")}] #{severity}: #{msg}\n"
|
21
|
+
}
|
22
|
+
end
|
23
|
+
|
24
|
+
# Backup and download MTik config
|
25
|
+
def backup(download=false)
|
26
|
+
@config.each do |config|
|
27
|
+
connect_to_host(config[:host],config[:user],config[:password])
|
28
|
+
backup_config(config[:name])
|
29
|
+
download_backup(config[:host],config[:user],config[:password],config[:name],config[:path]) if download
|
30
|
+
end
|
31
|
+
end
|
32
|
+
# Only download MTik config
|
33
|
+
def download
|
34
|
+
@config.each do |config|
|
35
|
+
download_backup(config[:host],config[:user],config[:password],config[:name],config[:path])
|
36
|
+
end
|
37
|
+
end
|
38
|
+
|
39
|
+
# Private section
|
40
|
+
private
|
41
|
+
# Function connect to SSH/SFTP host
|
42
|
+
def connect_to_host(host,user,password,sftp=false)
|
43
|
+
begin
|
44
|
+
if sftp
|
45
|
+
@log.info("SFTP connect to host #{host}")
|
46
|
+
@ssh_connect = Net::SFTP.start(host,user,:password=>password)
|
47
|
+
else
|
48
|
+
@log.info("SSH connect to host #{host}")
|
49
|
+
@ssh_connect = Net::SSH.start(host,user,:password=>password)
|
50
|
+
end
|
51
|
+
rescue Exception => error
|
52
|
+
@log.error("#{error}")
|
53
|
+
exit
|
54
|
+
end
|
55
|
+
end
|
56
|
+
# Backup function, send SSH command
|
57
|
+
def backup_config(name)
|
58
|
+
@log.info("Backup MikroTik configuration")
|
59
|
+
send_command("/export file=#{name}")
|
60
|
+
@ssh_connect.close
|
61
|
+
end
|
62
|
+
# Download backup file from host
|
63
|
+
def download_backup(host,user,password,name,path)
|
64
|
+
connect_to_host(host,user,password,true)
|
65
|
+
local_file = path+name+".rsc"
|
66
|
+
remote_file = name+".rsc"
|
67
|
+
download_file(remote_file,local_file)
|
68
|
+
@ssh_connect.close(@ssh_connect)
|
69
|
+
end
|
70
|
+
# Send command to host (SSH)
|
71
|
+
def send_command(command)
|
72
|
+
begin
|
73
|
+
@ssh_connect.exec!(command)
|
74
|
+
rescue Exception => error
|
75
|
+
@log.error("#{error}")
|
76
|
+
end
|
77
|
+
end
|
78
|
+
# Download file from host
|
79
|
+
def download_file(remote_file, local_file)
|
80
|
+
begin
|
81
|
+
@log.info("Download file #{remote_file} to #{local_file}")
|
82
|
+
@ssh_connect.download!(remote_file,local_file)
|
83
|
+
rescue Exception => error
|
84
|
+
@log.error("#{error}")
|
85
|
+
exit
|
86
|
+
end
|
87
|
+
end
|
88
|
+
end
|
89
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'mikrotik-backup/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "mikrotik-backup"
|
8
|
+
spec.version = MikrotikBackup::VERSION
|
9
|
+
spec.authors = ["POS_troi"]
|
10
|
+
spec.email = ["root@sysalex.com"]
|
11
|
+
spec.summary = %q{Backup MikroTik configuration using SSH and SFTP.}
|
12
|
+
spec.description = %q{Backup MikroTik configuration using SSH and SFTP.}
|
13
|
+
spec.homepage = "https://sysalex.com"
|
14
|
+
spec.license = "MIT"
|
15
|
+
|
16
|
+
spec.files = `git ls-files -z`.split("\x0")
|
17
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
18
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
19
|
+
spec.require_paths = ["lib"]
|
20
|
+
|
21
|
+
spec.add_development_dependency "bundler", "~> 1.7"
|
22
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
23
|
+
end
|
metadata
ADDED
@@ -0,0 +1,80 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: mikrotik-backup
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- POS_troi
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2015-02-10 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.7'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.7'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '10.0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '10.0'
|
41
|
+
description: Backup MikroTik configuration using SSH and SFTP.
|
42
|
+
email:
|
43
|
+
- root@sysalex.com
|
44
|
+
executables: []
|
45
|
+
extensions: []
|
46
|
+
extra_rdoc_files: []
|
47
|
+
files:
|
48
|
+
- ".gitignore"
|
49
|
+
- Gemfile
|
50
|
+
- LICENSE.txt
|
51
|
+
- README.md
|
52
|
+
- Rakefile
|
53
|
+
- lib/mikrotik-backup.rb
|
54
|
+
- lib/mikrotik-backup/version.rb
|
55
|
+
- mikrotik-backup.gemspec
|
56
|
+
homepage: https://sysalex.com
|
57
|
+
licenses:
|
58
|
+
- MIT
|
59
|
+
metadata: {}
|
60
|
+
post_install_message:
|
61
|
+
rdoc_options: []
|
62
|
+
require_paths:
|
63
|
+
- lib
|
64
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ">="
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0'
|
69
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
70
|
+
requirements:
|
71
|
+
- - ">="
|
72
|
+
- !ruby/object:Gem::Version
|
73
|
+
version: '0'
|
74
|
+
requirements: []
|
75
|
+
rubyforge_project:
|
76
|
+
rubygems_version: 2.4.5
|
77
|
+
signing_key:
|
78
|
+
specification_version: 4
|
79
|
+
summary: Backup MikroTik configuration using SSH and SFTP.
|
80
|
+
test_files: []
|