summaryrefslogtreecommitdiffstats
path: root/tools/generate_support_bundle.py
blob: 540b7a1357755d2fe5e95ec264ae3982e5e07f47 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
#!/usr/bin/python

########################################################
### Python Script to generate the FRR support bundle ###
########################################################
import os
import subprocess
import datetime

TOOLS_DIR="tools/"
ETC_DIR="/etc/frr/"
LOG_DIR="/var/log/frr/"
SUCCESS = 1
FAIL = 0

inputFile = ETC_DIR + "support_bundle_commands.conf"

# Open support bundle configuration file
def openConfFile(i_file):
  try:
    with open(i_file) as supportBundleConfFile:
      lines = filter(None, (line.rstrip() for line in supportBundleConfFile))
    return lines
  except IOError:
    return ([])

# Create the output file name
def createOutputFile(procName):
  fileName = procName + "_support_bundle.log"
  oldFile = LOG_DIR + fileName
  cpFileCmd = "cp " + oldFile + " " + oldFile + ".prev"
  rmFileCmd = "rm -rf " + oldFile
  print("Making backup of " + oldFile)
  os.system(cpFileCmd)
  print("Removing " + oldFile)
  os.system(rmFileCmd)
  return fileName

# Open the output file for this process
def openOutputFile(fileName):
  crt_file_cmd = LOG_DIR + fileName
  print(crt_file_cmd)
  try:
    outputFile = open(crt_file_cmd, "w")
    return outputFile
  except IOError:
    return ()

# Close the output file for this process
def closeOutputFile(file):
  try:
    file.close()
    return SUCCESS
  except IOError:
    return FAIL

# Execute the command over vtysh and store in the
# output file
def executeCommand(cmd, outputFile):
  cmd_exec_str = "vtysh -c \"" + cmd + "\" "
  try:
    cmd_output = subprocess.check_output(cmd_exec_str, shell=True)
    try:
      dateTime = datetime.datetime.now()
      outputFile.write(">>[" + str(dateTime) + "]" + cmd + "\n")
      outputFile.write(cmd_output)
      outputFile.write("########################################################\n")
      outputFile.write('\n')
    except:
      print("Writing to ouptut file Failed")
  except subprocess.CalledProcessError as e:
    dateTime = datetime.datetime.now()
    outputFile.write(">>[" + str(dateTime) + "]" + cmd + "\n")
    outputFile.write(e.output)
    outputFile.write("########################################################\n")
    outputFile.write('\n')
    print("Error:" + e.output)


# Process the support bundle configuration file
# and call appropriate functions
def processConfFile(lines):
  for line in lines:
    if line[0][0] == '#':
      continue
    cmd_line = line.split(':')
    if cmd_line[0] == "PROC_NAME":
      outputFileName = createOutputFile(cmd_line[1])
      if outputFileName:
        print(outputFileName, "created for", cmd_line[1])
    elif cmd_line[0] == "CMD_LIST_START":
      outputFile = openOutputFile(outputFileName)
      if outputFile:
        print(outputFileName, "opened")
      else:
        print(outputFileName, "open failed")
        return FAIL
    elif cmd_line[0] == "CMD_LIST_END":
      if closeOutputFile(outputFile):
        print(outputFileName, "closed")
      else:
        print(outputFileName, "close failed")
    else:
      print("Execute:" , cmd_line[0])
      executeCommand(cmd_line[0], outputFile)
      
# Main Function
lines = openConfFile(inputFile)
if not lines:
  print("File support_bundle_commands.conf not present in /etc/frr/ directory")
else:
  processConfFile(lines)