pbs_probe.8B 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118
  1. .\" Copyright (C) 1994-2018 Altair Engineering, Inc.
  2. .\" For more information, contact Altair at www.altair.com.
  3. .\"
  4. .\" This file is part of the PBS Professional ("PBS Pro") software.
  5. .\"
  6. .\" Open Source License Information:
  7. .\"
  8. .\" PBS Pro is free software. You can redistribute it and/or modify it under the
  9. .\" terms of the GNU Affero General Public License as published by the Free
  10. .\" Software Foundation, either version 3 of the License, or (at your option) any
  11. .\" later version.
  12. .\"
  13. .\" PBS Pro is distributed in the hope that it will be useful, but WITHOUT ANY
  14. .\" WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  15. .\" FOR A PARTICULAR PURPOSE.
  16. .\" See the GNU Affero General Public License for more details.
  17. .\"
  18. .\" You should have received a copy of the GNU Affero General Public License
  19. .\" along with this program. If not, see <http://www.gnu.org/licenses/>.
  20. .\"
  21. .\" Commercial License Information:
  22. .\"
  23. .\" For a copy of the commercial license terms and conditions,
  24. .\" go to: (http://www.pbspro.com/UserArea/agreement.html)
  25. .\" or contact the Altair Legal Department.
  26. .\"
  27. .\" Altair’s dual-license business model allows companies, individuals, and
  28. .\" organizations to create proprietary derivative works of PBS Pro and
  29. .\" distribute them - whether embedded or bundled with other software -
  30. .\" under a commercial license agreement.
  31. .\"
  32. .\" Use of Altair’s trademarks, including but not limited to "PBS™",
  33. .\" "PBS Professional®", and "PBS Pro™" and Altair’s logos is subject to Altair's
  34. .\" trademark licensing policies.
  35. .\"
  36. .TH pbs_probe 8B "23 October 2017" Local "PBS Professional"
  37. .SH NAME
  38. .B pbs_probe
  39. - report PBS diagnostic information and fix permission errors
  40. .SH SYNOPSIS
  41. .B pbs_probe
  42. [ -f | -v ]
  43. .br
  44. .B pbs_probe
  45. --version
  46. .SH DESCRIPTION
  47. .B Deprecated.
  48. The
  49. .B pbs_probe
  50. command reports post-installation information that is useful for PBS
  51. diagnostics, and fixes permission errors.
  52. .B Information Sources
  53. .RS 3
  54. Information that is supplied on the command line
  55. .br
  56. The file /etc/pbs.conf
  57. .br
  58. The file /etc/init.d/pbs
  59. .br
  60. The values of any of the following environment variables; these may
  61. be set in the environment in which
  62. .B pbs_probe
  63. is run: PBS_CONF_FILE, PBS_HOME, PBS_EXEC, PBS_START_SERVER, PBS_START_MOM,
  64. and PBS_START_SCHED
  65. .RE
  66. .B Required Privilege
  67. .br
  68. In order to execute
  69. .B pbs_probe,
  70. the user must have PBS Operator or Manager privilege.
  71. .SH OPTIONS
  72. .IP "(no options)" 10
  73. Run in "report" mode. In this mode
  74. .B pbs_probe
  75. reports any permission errors detected in the PBS infrastructure files.
  76. The command categorizes the errors and writes a list of them by category.
  77. Empty categories are not written.
  78. .IP "-f " 10
  79. Run in "fix" mode. In this mode pbs_probe examines each of the relevant
  80. infrastructure files and, where possible, fixes any errors that it detects,
  81. and prints a message of what got changed. If it is unable to fix a problem,
  82. it prints a message regarding what was detected.
  83. .IP "-v" 10
  84. Run in "verbose" mode. In this mode
  85. .B pbs_probe
  86. writes a complete list of the infrastructure files that it checked.
  87. .LP
  88. .IP "--version" 10
  89. The
  90. .B pbs_probe
  91. command returns its PBS version information and exits.
  92. This option can only be used alone.
  93. .SH STANDARD ERROR
  94. The
  95. .B pbs_probe
  96. command writes a diagnostic message to standard error for each error occurrence.
  97. .SH EXIT STATUS
  98. Exit code does not reflect results of probe; it reflects whether or not
  99. the program ran.
  100. .IP "Zero" 10
  101. When run correctly, whether or not
  102. .B pbs_probe
  103. finds any problems or errors
  104. .IP "Non-negative" 10
  105. When run incorrectly
  106. .RE
  107. .SH SEE ALSO
  108. The
  109. .B PBS Professional Administrator's Guide
  110. and the following manual pages:
  111. pbs_server(8B), pbs_sched(8B), pbs_mom(8B).