source3/utils/net_help.c

   1 /*
   2    Samba Unix/Linux SMB client library
   3    net help commands
   4    Copyright (C) 2002 Jim McDonough (jmcd@us.ibm.com)
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 2 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program; if not, write to the Free Software
  18    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19 */
  20
  21 #include "includes.h"
  22 #include "../utils/net.h"
  23
  24 int net_common_methods_usage(int argc, const char**argv)
  25 {
  26         d_printf("Valid methods: (auto-detected if not specified)\n");
  27         d_printf("\tads\t\t\t\tActive Directory (LDAP/Kerberos)\n");
  28         d_printf("\trpc\t\t\t\tDCE-RPC\n");
  29         d_printf("\trap\t\t\t\tRAP (older systems)\n");
  30         d_printf("\n");
  31         return 0;
  32 }
  33
  34 int net_common_flags_usage(int argc, const char **argv)
  35 {
  36         d_printf("Valid targets: choose one (none defaults to localhost)\n");
  37         d_printf("\t-S or --server=<server>\t\tserver name\n");
  38         d_printf("\t-I or --ipaddress=<ipaddr>\taddress of target server\n");
  39         d_printf("\t-w or --workgroup=<wg>\t\ttarget workgroup or domain\n");
  40
  41         d_printf("\n");
  42         d_printf("Valid miscellaneous options are:\n"); /* misc options */
  43         d_printf("\t-p or --port=<port>\t\tconnection port on target\n");
  44         d_printf("\t-W or --myworkgroup=<wg>\tclient workgroup\n");
  45         d_printf("\t-d or --debuglevel=<level>\tdebug level (0-10)\n");
  46         d_printf("\t-n or --myname=<name>\t\tclient name\n");
  47         d_printf("\t-U or --user=<name>\t\tuser name\n");
  48         d_printf("\t-s or --configfile=<path>\tpathname of smb.conf file\n");
  49         d_printf("\t-l or --long\t\t\tDisplay full information\n");
  50         d_printf("\t-V or --version\t\t\tPrint samba version information\n");
  51         d_printf("\t-P or --machine-pass\t\tAuthenticate as machine account\n");
  52         return -1;
  53 }
  54
  55 static int help_usage(int argc, const char **argv)
  56 {
  57         d_printf(
  58 "\n"\
  59 "Usage: net help <function>\n"\
  60 "\n"\
  61 "Valid functions are:\n"\
  62 "  RPC RAP ADS FILE SHARE SESSION SERVER DOMAIN PRINTQ USER GROUP VALIDATE\n"\
  63 "  GROUPMEMBER ADMIN SERVICE PASSWORD TIME LOOKUP GETLOCALSID SETLOCALSID\n"\
  64 "  CHANGESCRETPW\n");
  65         return -1;
  66 }
  67
  68 int net_help_user(int argc, const char **argv)
  69 {
  70         d_printf("\nnet [<method>] user [misc. options] [targets]"\
  71                  "\n\tList users\n\n");
  72         d_printf("net [<method>] user DELETE <name> [misc. options] [targets]"\
  73                  "\n\tDelete specified user\n");
  74         d_printf("\nnet [<method>] user INFO <name> [misc. options] [targets]"\
  75                  "\n\tList the domain groups of the specified user\n");
  76         d_printf("\nnet [<method>] user ADD <name> [password] [-c container] "\
  77                  "[-F user flags] [misc. options]"\
  78                  " [targets]\n\tAdd specified user\n");
  79
  80         net_common_methods_usage(argc, argv);
  81         net_common_flags_usage(argc, argv);
  82         d_printf("\t-C or --comment=<comment>\tdescriptive comment (for add only)\n");
  83         d_printf("\t-c or --container=<container>\tLDAP container, defaults to cn=Users (for add in ADS only)\n");
  84         return -1;
  85 }
  86
  87 int net_help_group(int argc, const char **argv)
  88 {
  89         d_printf("net [<method>] group [misc. options] [targets]"\
  90                  "\n\tList user groups\n\n");
  91         d_printf("net rpc group LIST [global|local|builtin]* [misc. options]"\
  92                  "\n\tList specific user groups\n\n");
  93         d_printf("net [<method>] group DELETE <name> "\
  94                  "[misc. options] [targets]"\
  95                  "\n\tDelete specified group\n");
  96         d_printf("\nnet [<method>] group ADD <name> [-C comment] [-c container]"\
  97                  " [misc. options] [targets]\n\tCreate specified group\n");
  98         d_printf("\nnet rpc group MEMBERS <name>\n\tList Group Members\n\n");
  99         net_common_methods_usage(argc, argv);
 100         net_common_flags_usage(argc, argv);
 101         d_printf("\t-C or --comment=<comment>\tdescriptive comment (for add only)\n");
 102         d_printf("\t-c or --container=<container>\tLDAP container, defaults to cn=Users (for add in ADS only)\n");
 103         return -1;
 104 }
 105
 106 int net_help_join(int argc, const char **argv)
 107 {
 108         d_printf("\nnet [<method>] join [misc. options]\n"
 109                  "\tjoins this server to a domain\n");
 110         d_printf("Valid methods: (auto-detected if not specified)\n");
 111         d_printf("\tads\t\t\t\tActive Directory (LDAP/Kerberos)\n");
 112         d_printf("\trpc\t\t\t\tDCE-RPC\n");
 113         net_common_flags_usage(argc, argv);
 114         return -1;
 115 }
 116
 117 int net_help_share(int argc, const char **argv)
 118 {
 119         d_printf(
 120          "\nnet [<method>] share [misc. options] [targets] \n"
 121          "\tenumerates all exported resources (network shares) "
 122          "on target server\n\n"
 123          "net [<method>] share ADD <name=serverpath> [misc. options] [targets]"
 124          "\n\tAdds a share from a server (makes the export active)\n\n"
 125          "net [<method>] share DELETE <sharename> [misc. options] [targets]"
 126          "\n\tDeletes a share from a server (makes the export inactive)\n\n"
 127          "net [<method>] share MIGRATE FILES <sharename> [misc. options] [targets]"
 128          "\n\tMigrates files from remote to local server\n\n"
 129          "net [<method>] share MIGRATE SHARES <sharename> [misc. options] [targets]"
 130          "\n\tMigrates shares from remote to local server\n\n"
 131 /*       "net [<method>] share MIGRATE SECURITY <sharename> [misc. options] [targets]"
 132          "\n\tMigrates share-ACLs from remote to local server\n\n" */
 133          "net [<method>] share MIGRATE ALL <sharename> [misc. options] [targets]"
 134          "\n\tMigrates shares (including directories, files) from remote\n"
 135          "\tto local server\n\n"
 136         );
 137         net_common_methods_usage(argc, argv);
 138         net_common_flags_usage(argc, argv);
 139         d_printf(
 140          "\t-C or --comment=<comment>\tdescriptive comment (for add only)\n"
 141          "\t-M or --maxusers=<num>\t\tmax users allowed for share\n"
 142          "\t-a or --acls\t\t\tcopies ACLs as well\n"
 143          "\t-e or --exclude\t\t\tlist of shares to be excluded from mirroring\n");
 144         return -1;
 145 }
 146
 147 int net_help_file(int argc, const char **argv)
 148 {
 149         d_printf("net [<method>] file [misc. options] [targets]\n"\
 150                  "\tlists all open files on file server\n\n");
 151         d_printf("net [<method>] file USER <username> "\
 152                  "[misc. options] [targets]"\
 153                  "\n\tlists all files opened by username on file server\n\n");
 154         d_printf("net [<method>] file CLOSE <id> [misc. options] [targets]\n"\
 155                  "\tcloses specified file on target server\n\n");
 156         d_printf("net [rap] file INFO <id> [misc. options] [targets]\n"\
 157                  "\tdisplays information about the specified open file\n");
 158
 159         net_common_methods_usage(argc, argv);
 160         net_common_flags_usage(argc, argv);
 161         return -1;
 162 }
 163
 164 int net_help_printer(int argc, const char **argv)
 165 {
 166         d_printf("net rpc printer LIST [printer]\n"\
 167                  "\tlists all printers on print-server\n\n");
 168         d_printf("net rpc printer DRIVER [printer]\n"\
 169                  "\tlists all printer-drivers on print-server\n\n");
 170         d_printf("net rpc printer MIGRATE PRINTERS [printer]"\
 171                  "\n\tmigrates printers from remote to local server\n\n");
 172         d_printf("net rpc printer MIGRATE SETTINGS [printer]"\
 173                  "\n\tmigrates printer-settings from remote to local server\n\n");
 174         d_printf("net rpc printer MIGRATE DRIVERS [printer]"\
 175                  "\n\tmigrates printer-drivers from remote to local server\n\n");
 176         d_printf("net rpc printer MIGRATE FORMS [printer]"\
 177                  "\n\tmigrates printer-forms from remote to local server\n\n");
 178         d_printf("net rpc printer MIGRATE SECURITY [printer]"\
 179                  "\n\tmigrates printer-ACLs from remote to local server\n\n");
 180         d_printf("net rpc printer MIGRATE ALL [printer]\n"\
 181                  "\tmigrates drivers, forms, queues, settings and acls from\n"\
 182                  "\tremote to local print-server\n\n");
 183         net_common_methods_usage(argc, argv);
 184         net_common_flags_usage(argc, argv);
 185         return -1;
 186 }
 187
 188
 189 int net_help_status(int argc, const char **argv)
 190 {
 191         d_printf("  net status sessions [parseable] "
 192                  "Show list of open sessions\n");
 193         d_printf("  net status shares [parseable]   "
 194                  "Show list of open shares\n");
 195         return -1;
 196 }
 197
 198 static int net_usage(int argc, const char **argv)
 199 {
 200         d_printf("  net time\t\tto view or set time information\n"\
 201                  "  net lookup\t\tto lookup host name or ip address\n"\
 202                  "  net user\t\tto manage users\n"\
 203                  "  net group\t\tto manage groups\n"\
 204                  "  net groupmap\t\tto manage group mappings\n"\
 205                  "  net join\t\tto join a domain\n"\
 206                  "  net cache\t\tto operate on cache tdb file\n"\
 207                  "  net getlocalsid [NAME]\tto get the SID for local name\n"\
 208                  "  net setlocalsid SID\tto set the local domain SID\n"\
 209                  "  net changesecretpw\tto change the machine password in the local secrets database only\n"\
 210                  "                    \tthis requires the -f flag as a safety barrier\n"\
 211                  "  net status\t\tShow server status\n"\
 212                  "\n"\
 213                  "  net ads <command>\tto run ADS commands\n"\
 214                  "  net rap <command>\tto run RAP (pre-RPC) commands\n"\
 215                  "  net rpc <command>\tto run RPC commands\n"\
 216                  "\n"\
 217                  "Type \"net help <option>\" to get more information on that option\n");
 218         net_common_flags_usage(argc, argv);
 219         return -1;
 220 }
 221
 222 /*
 223   handle "net help *" subcommands
 224 */
 225 int net_help(int argc, const char **argv)
 226 {
 227         struct functable func[] = {
 228                 {"ADS", net_ads_help},
 229                 {"RAP", net_rap_help},
 230                 {"RPC", net_rpc_help},
 231
 232                 {"FILE", net_help_file},
 233                 {"SHARE", net_help_share},
 234                 {"SESSION", net_rap_session_usage},
 235                 {"SERVER", net_rap_server_usage},
 236                 {"DOMAIN", net_rap_domain_usage},
 237                 {"PRINTQ", net_rap_printq_usage},
 238                 {"USER", net_help_user},
 239                 {"GROUP", net_help_group},
 240                 {"GROUPMAP", net_help_groupmap},
 241                 {"JOIN", net_help_join},
 242                 {"VALIDATE", net_rap_validate_usage},
 243                 {"GROUPMEMBER", net_rap_groupmember_usage},
 244                 {"ADMIN", net_rap_admin_usage},
 245                 {"SERVICE", net_rap_service_usage},
 246                 {"PASSWORD", net_rap_password_usage},
 247                 {"TIME", net_time_usage},
 248                 {"LOOKUP", net_lookup_usage},
 249 #ifdef WITH_FAKE_KASERVER
 250                 {"AFSKEY", net_afskey_usage},
 251 #endif
 252
 253                 {"HELP", help_usage},
 254                 {NULL, NULL}};
 255
 256         return net_run_function(argc, argv, func, net_usage);
 257 }