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 3 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, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include "includes.h"
  21 #include "utils/net.h"
  22
  23 int net_common_methods_usage(int argc, const char**argv)
  24 {
  25         d_printf("Valid methods: (auto-detected if not specified)\n");
  26         d_printf("\tads\t\t\t\tActive Directory (LDAP/Kerberos)\n");
  27         d_printf("\trpc\t\t\t\tDCE-RPC\n");
  28         d_printf("\trap\t\t\t\tRAP (older systems)\n");
  29         d_printf("\n");
  30         return 0;
  31 }
  32
  33 int net_common_flags_usage(int argc, const char **argv)
  34 {
  35         d_printf("Valid targets: choose one (none defaults to localhost)\n");
  36         d_printf("\t-S or --server=<server>\t\tserver name\n");
  37         d_printf("\t-I or --ipaddress=<ipaddr>\taddress of target server\n");
  38         d_printf("\t-w or --workgroup=<wg>\t\ttarget workgroup or domain\n");
  39
  40         d_printf("\n");
  41         d_printf("Valid miscellaneous options are:\n"); /* misc options */
  42         d_printf("\t-p or --port=<port>\t\tconnection port on target\n");
  43         d_printf("\t-W or --myworkgroup=<wg>\tclient workgroup\n");
  44         d_printf("\t-d or --debuglevel=<level>\tdebug level (0-10)\n");
  45         d_printf("\t-n or --myname=<name>\t\tclient name\n");
  46         d_printf("\t-U or --user=<name>\t\tuser name\n");
  47         d_printf("\t-s or --configfile=<path>\tpathname of smb.conf file\n");
  48         d_printf("\t-l or --long\t\t\tDisplay full information\n");
  49         d_printf("\t-V or --version\t\t\tPrint samba version information\n");
  50         d_printf("\t-P or --machine-pass\t\tAuthenticate as machine account\n");
  51         return -1;
  52 }
  53
  54 static int help_usage(int argc, const char **argv)
  55 {
  56         d_printf(
  57 "\n"\
  58 "Usage: net help <function>\n"\
  59 "\n"\
  60 "Valid functions are:\n"\
  61 "  RPC RAP ADS FILE SHARE SESSION SERVER DOMAIN PRINTQ USER GROUP VALIDATE\n"\
  62 "  GROUPMEMBER ADMIN SERVICE PASSWORD TIME LOOKUP GETLOCALSID SETLOCALSID\n"\
  63 "  SETDOMAINSID CHANGESCRETPW LOOKUP SAM\n");
  64         return -1;
  65 }
  66
  67 int net_help_user(int argc, const char **argv)
  68 {
  69         d_printf("\nnet [<method>] user [misc. options] [targets]"\
  70                  "\n\tList users\n\n");
  71         d_printf("net [<method>] user DELETE <name> [misc. options] [targets]"\
  72                  "\n\tDelete specified user\n");
  73         d_printf("\nnet [<method>] user INFO <name> [misc. options] [targets]"\
  74                  "\n\tList the domain groups of the specified user\n");
  75         d_printf("\nnet [<method>] user ADD <name> [password] [-c container] "\
  76                  "[-F user flags] [misc. options]"\
  77                  " [targets]\n\tAdd specified user\n");
  78         d_printf("\nnet [<method>] user RENAME <oldusername> <newusername>"\
  79                  " [targets]\n\tRename specified user\n\n");
  80
  81
  82         net_common_methods_usage(argc, argv);
  83         net_common_flags_usage(argc, argv);
  84         d_printf("\t-C or --comment=<comment>\tdescriptive comment (for add only)\n");
  85         d_printf("\t-c or --container=<container>\tLDAP container, defaults to cn=Users (for add in ADS only)\n");
  86         return -1;
  87 }
  88
  89 int net_help_group(int argc, const char **argv)
  90 {
  91         d_printf("net [<method>] group [misc. options] [targets]"\
  92                  "\n\tList user groups\n\n");
  93         d_printf("net rpc group LIST [global|local|builtin]* [misc. options]"\
  94                  "\n\tList specific user groups\n\n");
  95         d_printf("net [<method>] group DELETE <name> "\
  96                  "[misc. options] [targets]"\
  97                  "\n\tDelete specified group\n");
  98         d_printf("\nnet [<method>] group ADD <name> [-C comment] [-c container]"\
  99                  " [misc. options] [targets]\n\tCreate specified group\n");
 100         d_printf("\nnet rpc group MEMBERS <name>\n\tList Group Members\n\n");
 101         d_printf("\nnet rpc group ADDMEM <group> <member>\n\tAdd Group Members\n\n");
 102         d_printf("\nnet rpc group DELMEM <group> <member>\n\tDelete Group Members\n\n");
 103         net_common_methods_usage(argc, argv);
 104         net_common_flags_usage(argc, argv);
 105         d_printf("\t-C or --comment=<comment>\tdescriptive comment (for add only)\n");
 106         d_printf("\t-c or --container=<container>\tLDAP container, defaults to cn=Users (for add in ADS only)\n");
 107         d_printf("\t-L or --localgroup\t\tWhen adding groups, create a local group (alias)\n");
 108         return -1;
 109 }
 110
 111 int net_help_join(int argc, const char **argv)
 112 {
 113         d_printf("\nnet [<method>] join [misc. options]\n"
 114                  "\tjoins this server to a domain\n");
 115         d_printf("Valid methods: (auto-detected if not specified)\n");
 116         d_printf("\tads\t\t\t\tActive Directory (LDAP/Kerberos)\n");
 117         d_printf("\trpc\t\t\t\tDCE-RPC\n");
 118         net_common_flags_usage(argc, argv);
 119         return -1;
 120 }
 121
 122 int net_help_share(int argc, const char **argv)
 123 {
 124         d_printf(
 125          "\nnet [<method>] share [misc. options] [targets] \n"
 126          "\tenumerates all exported resources (network shares) "
 127          "on target server\n\n"
 128          "net [<method>] share ADD <name=serverpath> [misc. options] [targets]"
 129         "\n\tadds a share from a server (makes the export active)\n\n"
 130         "net [<method>] share DELETE <sharename> [misc. options] [targets]"
 131         "\n\tdeletes a share from a server (makes the export inactive)\n\n"
 132         "net [<method>] share ALLOWEDUSERS [<filename>] "
 133         "[misc. options] [targets]"
 134         "\n\tshows a list of all shares together with all users allowed to"
 135         "\n\taccess them. This needs the output of 'net usersidlist' on"
 136         "\n\tstdin or in <filename>.\n\n"
 137          "net [<method>] share MIGRATE FILES <sharename> [misc. options] [targets]"
 138          "\n\tMigrates files from remote to local server\n\n"
 139          "net [<method>] share MIGRATE SHARES <sharename> [misc. options] [targets]"
 140          "\n\tMigrates shares from remote to local server\n\n"
 141          "net [<method>] share MIGRATE SECURITY <sharename> [misc. options] [targets]"
 142          "\n\tMigrates share-ACLs from remote to local server\n\n"
 143          "net [<method>] share MIGRATE ALL <sharename> [misc. options] [targets]"
 144          "\n\tMigrates shares (including directories, files) from remote\n"
 145          "\tto local server\n\n"
 146         );
 147         net_common_methods_usage(argc, argv);
 148         net_common_flags_usage(argc, argv);
 149         d_printf(
 150          "\t-C or --comment=<comment>\tdescriptive comment (for add only)\n"
 151          "\t-M or --maxusers=<num>\t\tmax users allowed for share\n"
 152          "\t      --acls\t\t\tcopies ACLs as well\n"
 153          "\t      --attrs\t\t\tcopies DOS Attributes as well\n"
 154          "\t      --timestamps\t\tpreserve timestamps while copying files\n"
 155          "\t      --destination\t\tmigration target server (default: localhost)\n"
 156          "\t-e or --exclude\t\t\tlist of shares to be excluded from mirroring\n"
 157          "\t-v or --verbose\t\t\tgive verbose output\n");
 158         return -1;
 159 }
 160
 161 int net_help_file(int argc, const char **argv)
 162 {
 163         d_printf("net [<method>] file [misc. options] [targets]\n"\
 164                  "\tlists all open files on file server\n\n");
 165         d_printf("net [<method>] file USER <username> "\
 166                  "[misc. options] [targets]"\
 167                  "\n\tlists all files opened by username on file server\n\n");
 168         d_printf("net [<method>] file CLOSE <id> [misc. options] [targets]\n"\
 169                  "\tcloses specified file on target server\n\n");
 170         d_printf("net [rap] file INFO <id> [misc. options] [targets]\n"\
 171                  "\tdisplays information about the specified open file\n");
 172
 173         net_common_methods_usage(argc, argv);
 174         net_common_flags_usage(argc, argv);
 175         return -1;
 176 }
 177
 178 int net_help_printer(int argc, const char **argv)
 179 {
 180         d_printf("net rpc printer LIST [printer] [misc. options] [targets]\n"\
 181                  "\tlists all printers on print-server\n\n");
 182         d_printf("net rpc printer DRIVER [printer] [misc. options] [targets]\n"\
 183                  "\tlists all printer-drivers on print-server\n\n");
 184         d_printf("net rpc printer PUBLISH action [printer] [misc. options] [targets]\n"\
 185                  "\tpublishes printer settings in Active Directory\n"
 186                  "\taction can be one of PUBLISH, UPDATE, UNPUBLISH or LIST\n\n");
 187         d_printf("net rpc printer MIGRATE PRINTERS [printer] [misc. options] [targets]"\
 188                  "\n\tmigrates printers from remote to local server\n\n");
 189         d_printf("net rpc printer MIGRATE SETTINGS [printer] [misc. options] [targets]"\
 190                  "\n\tmigrates printer-settings from remote to local server\n\n");
 191         d_printf("net rpc printer MIGRATE DRIVERS [printer] [misc. options] [targets]"\
 192                  "\n\tmigrates printer-drivers from remote to local server\n\n");
 193         d_printf("net rpc printer MIGRATE FORMS [printer] [misc. options] [targets]"\
 194                  "\n\tmigrates printer-forms from remote to local server\n\n");
 195         d_printf("net rpc printer MIGRATE SECURITY [printer] [misc. options] [targets]"\
 196                  "\n\tmigrates printer-ACLs from remote to local server\n\n");
 197         d_printf("net rpc printer MIGRATE ALL [printer] [misc. options] [targets]"\
 198                  "\n\tmigrates drivers, forms, queues, settings and acls from\n"\
 199                  "\tremote to local print-server\n\n");
 200         net_common_methods_usage(argc, argv);
 201         net_common_flags_usage(argc, argv);
 202         d_printf(
 203          "\t-v or --verbose\t\t\tgive verbose output\n"
 204          "\t      --destination\t\tmigration target server (default: localhost)\n");
 205
 206         return -1;
 207 }
 208
 209
 210 int net_help_status(int argc, const char **argv)
 211 {
 212         d_printf("  net status sessions [parseable] "
 213                  "Show list of open sessions\n");
 214         d_printf("  net status shares [parseable]   "
 215                  "Show list of open shares\n");
 216         return -1;
 217 }
 218
 219 static int net_usage(int argc, const char **argv)
 220 {
 221         d_printf("  net time\t\tto view or set time information\n"\
 222                  "  net lookup\t\tto lookup host name or ip address\n"\
 223                  "  net user\t\tto manage users\n"\
 224                  "  net group\t\tto manage groups\n"\
 225                  "  net sam\t\tto edit the local user database directly\n"\
 226                  "  net lookup\t\tto look up various things\n"\
 227                  "  net groupmap\t\tto manage group mappings\n"\
 228                  "  net join\t\tto join a domain\n"\
 229                  "  net cache\t\tto operate on cache tdb file\n"\
 230                  "  net getlocalsid [NAME]\tto get the SID for local name\n"\
 231                  "  net setlocalsid SID\tto set the local domain SID\n"\
 232                  "  net setdomainsid SID\tto set the domain SID on member servers\n"\
 233                  "  net changesecretpw\tto change the machine password in the local secrets database only\n"\
 234                  "                    \tthis requires the -f flag as a safety barrier\n"\
 235                  "  net status\t\tShow server status\n"\
 236                  "  net usersidlist\tto get a list of all users with their SIDs\n"
 237                  "  net usershare\t\tto add, delete and list locally user-modifiable shares\n"
 238                  "  net conf\t\tto view and edit samba's registry based configuration\n"
 239                  "\n"\
 240                  "  net ads <command>\tto run ADS commands\n"\
 241                  "  net rap <command>\tto run RAP (pre-RPC) commands\n"\
 242                  "  net rpc <command>\tto run RPC commands\n"\
 243                  "\n"\
 244                  "Type \"net help <option>\" to get more information on that option\n");
 245         net_common_flags_usage(argc, argv);
 246         return -1;
 247 }
 248
 249 /*
 250   handle "net help *" subcommands
 251 */
 252 int net_help(int argc, const char **argv)
 253 {
 254         struct functable func[] = {
 255                 {"ADS", net_ads_help},
 256                 {"RAP", net_rap_help},
 257                 {"RPC", net_rpc_help},
 258
 259                 {"FILE", net_help_file},
 260                 {"SHARE", net_help_share},
 261                 {"SESSION", net_rap_session_usage},
 262                 {"SERVER", net_rap_server_usage},
 263                 {"DOMAIN", net_rap_domain_usage},
 264                 {"PRINTQ", net_rap_printq_usage},
 265                 {"USER", net_help_user},
 266                 {"GROUP", net_help_group},
 267                 {"GROUPMAP", net_help_groupmap},
 268                 {"JOIN", net_help_join},
 269                 {"DOM", net_help_dom},
 270                 {"VALIDATE", net_rap_validate_usage},
 271                 {"GROUPMEMBER", net_rap_groupmember_usage},
 272                 {"ADMIN", net_rap_admin_usage},
 273                 {"SERVICE", net_rap_service_usage},
 274                 {"PASSWORD", net_rap_password_usage},
 275                 {"TIME", net_time_usage},
 276                 {"LOOKUP", net_lookup_usage},
 277                 {"USERSHARE", net_usershare_usage},
 278                 {"USERSIDLIST", net_usersidlist_usage},
 279 #ifdef WITH_FAKE_KASERVER
 280                 {"AFS", net_help_afs},
 281 #endif
 282
 283                 {"HELP", help_usage},
 284                 {NULL, NULL}};
 285
 286         return net_run_function(argc, argv, func, net_usage);
 287 }