salt-proxy.1 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126
  1. .\" Man page generated from reStructuredText.
  2. .
  3. .TH "SALT-PROXY" "1" "Apr 14, 2020" "3000.2" "Salt"
  4. .SH NAME
  5. salt-proxy \- salt-proxy Documentation
  6. .
  7. .nr rst2man-indent-level 0
  8. .
  9. .de1 rstReportMargin
  10. \\$1 \\n[an-margin]
  11. level \\n[rst2man-indent-level]
  12. level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  13. -
  14. \\n[rst2man-indent0]
  15. \\n[rst2man-indent1]
  16. \\n[rst2man-indent2]
  17. ..
  18. .de1 INDENT
  19. .\" .rstReportMargin pre:
  20. . RS \\$1
  21. . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  22. . nr rst2man-indent-level +1
  23. .\" .rstReportMargin post:
  24. ..
  25. .de UNINDENT
  26. . RE
  27. .\" indent \\n[an-margin]
  28. .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  29. .nr rst2man-indent-level -1
  30. .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  31. .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  32. ..
  33. .sp
  34. Receives commands from a Salt master and proxies these commands to
  35. devices that are unable to run a full minion.
  36. .SH SYNOPSIS
  37. .INDENT 0.0
  38. .INDENT 3.5
  39. .sp
  40. .nf
  41. .ft C
  42. salt\-proxy [ options ]
  43. .ft P
  44. .fi
  45. .UNINDENT
  46. .UNINDENT
  47. .SH DESCRIPTION
  48. .sp
  49. The Salt proxy minion receives commands from a Salt master, transmits
  50. appropriate commands to devices that are unable to run a minion, and replies
  51. with the results of said commands.
  52. .SH OPTIONS
  53. .INDENT 0.0
  54. .TP
  55. .B \-\-proxyid
  56. The minion id that this proxy will assume. This is required.
  57. .UNINDENT
  58. .INDENT 0.0
  59. .TP
  60. .B \-\-version
  61. Print the version of Salt that is running.
  62. .UNINDENT
  63. .INDENT 0.0
  64. .TP
  65. .B \-\-versions\-report
  66. Show program\(aqs dependencies and version number, and then exit
  67. .UNINDENT
  68. .INDENT 0.0
  69. .TP
  70. .B \-h, \-\-help
  71. Show the help message and exit
  72. .UNINDENT
  73. .INDENT 0.0
  74. .TP
  75. .B \-c CONFIG_DIR, \-\-config\-dir=CONFIG_dir
  76. The location of the Salt configuration directory. This directory
  77. contains the configuration files for Salt master and minions.
  78. The default location on most systems is \fB/etc/salt\fP\&.
  79. .UNINDENT
  80. .INDENT 0.0
  81. .TP
  82. .B \-u USER, \-\-user=USER
  83. Specify user to run salt\-proxy
  84. .UNINDENT
  85. .INDENT 0.0
  86. .TP
  87. .B \-d, \-\-daemon
  88. Run salt\-proxy as a daemon
  89. .UNINDENT
  90. .INDENT 0.0
  91. .TP
  92. .B \-\-pid\-file PIDFILE
  93. Specify the location of the pidfile. Default: \fB/var/run/salt\-proxy\-<id>.pid\fP
  94. .UNINDENT
  95. .SS Logging Options
  96. .sp
  97. Logging options which override any settings defined on the configuration files.
  98. .INDENT 0.0
  99. .TP
  100. .B \-l LOG_LEVEL, \-\-log\-level=LOG_LEVEL
  101. Console logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
  102. \fBdebug\fP, \fBinfo\fP, \fBwarning\fP, \fBerror\fP, \fBquiet\fP\&. Default:
  103. \fBwarning\fP\&.
  104. .UNINDENT
  105. .INDENT 0.0
  106. .TP
  107. .B \-\-log\-file=LOG_FILE
  108. Log file path. Default: /var/log/salt/minion\&.
  109. .UNINDENT
  110. .INDENT 0.0
  111. .TP
  112. .B \-\-log\-file\-level=LOG_LEVEL_LOGFILE
  113. Logfile logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
  114. \fBdebug\fP, \fBinfo\fP, \fBwarning\fP, \fBerror\fP, \fBquiet\fP\&. Default:
  115. \fBwarning\fP\&.
  116. .UNINDENT
  117. .SH SEE ALSO
  118. .sp
  119. \fBsalt(1)\fP
  120. \fBsalt(7)\fP
  121. \fBsalt\-master(1)\fP
  122. \fBsalt\-minion(1)\fP
  123. .SH AUTHOR
  124. Thomas S. Hatch <thatch45@gmail.com> and many others, please see the Authors file
  125. .\" Generated by docutils manpage writer.
  126. .