salt-api.1 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112
  1. .\" Man page generated from reStructuredText.
  2. .
  3. .TH "SALT-API" "1" "May 21, 2020" "3001" "Salt"
  4. .SH NAME
  5. salt-api \- salt-api Command
  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. Start interfaces used to remotely connect to the salt master
  35. .SH SYNOPSIS
  36. .INDENT 0.0
  37. .INDENT 3.5
  38. .sp
  39. .nf
  40. .ft C
  41. salt\-api
  42. .ft P
  43. .fi
  44. .UNINDENT
  45. .UNINDENT
  46. .SH DESCRIPTION
  47. .sp
  48. The Salt API system manages network api connectors for the Salt Master
  49. .SH OPTIONS
  50. .INDENT 0.0
  51. .TP
  52. .B \-\-version
  53. Print the version of Salt that is running.
  54. .UNINDENT
  55. .INDENT 0.0
  56. .TP
  57. .B \-\-versions\-report
  58. Show program\(aqs dependencies and version number, and then exit
  59. .UNINDENT
  60. .INDENT 0.0
  61. .TP
  62. .B \-h, \-\-help
  63. Show the help message and exit
  64. .UNINDENT
  65. .INDENT 0.0
  66. .TP
  67. .B \-c CONFIG_DIR, \-\-config\-dir=CONFIG_dir
  68. The location of the Salt configuration directory. This directory contains
  69. the configuration files for Salt master and minions. The default location
  70. on most systems is \fB/etc/salt\fP\&.
  71. .UNINDENT
  72. .INDENT 0.0
  73. .TP
  74. .B \-d, \-\-daemon
  75. Run the salt\-api as a daemon
  76. .UNINDENT
  77. .INDENT 0.0
  78. .TP
  79. .B \-\-pid\-file=PIDFILE
  80. Specify the location of the pidfile. Default: /var/run/salt\-api.pid
  81. .UNINDENT
  82. .SS Logging Options
  83. .sp
  84. Logging options which override any settings defined on the configuration files.
  85. .INDENT 0.0
  86. .TP
  87. .B \-l LOG_LEVEL, \-\-log\-level=LOG_LEVEL
  88. Console logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
  89. \fBdebug\fP, \fBinfo\fP, \fBwarning\fP, \fBerror\fP, \fBquiet\fP\&. Default:
  90. \fBwarning\fP\&.
  91. .UNINDENT
  92. .INDENT 0.0
  93. .TP
  94. .B \-\-log\-file=LOG_FILE
  95. Log file path. Default: /var/log/salt/api\&.
  96. .UNINDENT
  97. .INDENT 0.0
  98. .TP
  99. .B \-\-log\-file\-level=LOG_LEVEL_LOGFILE
  100. Logfile logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
  101. \fBdebug\fP, \fBinfo\fP, \fBwarning\fP, \fBerror\fP, \fBquiet\fP\&. Default:
  102. \fBwarning\fP\&.
  103. .UNINDENT
  104. .SH SEE ALSO
  105. .sp
  106. \fBsalt\-api(7)\fP
  107. \fBsalt(7)\fP
  108. \fBsalt\-master(1)\fP
  109. .SH AUTHOR
  110. Thomas S. Hatch <thatch45@gmail.com> and many others, please see the Authors file
  111. .\" Generated by docutils manpage writer.
  112. .