net: Autogenerate "net help" output from net's functable.
[Samba.git] / source / utils / net.h
blobd1e759c5a95aeb5b5d4e95be393012aa0ea31702
1 /*
2 Samba Unix/Linux SMB client library
3 Distributed SMB/CIFS Server Management Utility
4 Copyright (C) 2001 Andrew Bartlett (abartlet@samba.org)
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.
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.
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/>. */
20 * A function of this type is passed to the '
21 * run_rpc_command' wrapper. Must go before the net_proto.h
22 * include
25 #include "lib/netapi/netapi.h"
27 struct net_context {
28 const char *opt_requester_name;
29 const char *opt_host;
30 const char *opt_password;
31 const char *opt_user_name;
32 bool opt_user_specified;
33 const char *opt_workgroup;
34 int opt_long_list_entries;
35 int opt_reboot;
36 int opt_force;
37 int opt_stdin;
38 int opt_port;
39 int opt_verbose;
40 int opt_maxusers;
41 const char *opt_comment;
42 const char *opt_container;
43 int opt_flags;
44 int opt_timeout;
45 const char *opt_target_workgroup;
46 int opt_machine_pass;
47 int opt_localgroup;
48 int opt_domaingroup;
49 int do_talloc_report;
50 const char *opt_newntname;
51 int opt_rid;
52 int opt_acls;
53 int opt_attrs;
54 int opt_timestamps;
55 const char *opt_exclude;
56 const char *opt_destination;
57 int opt_testmode;
59 int opt_have_ip;
60 struct sockaddr_storage opt_dest_ip;
61 bool smb_encrypt;
62 struct libnetapi_ctx *netapi_ctx;
64 bool display_usage;
65 void *private_data;
66 const char *share_type[];
69 #define NET_TRANSPORT_LOCAL 0x01
70 #define NET_TRANSPORT_RAP 0x02
71 #define NET_TRANSPORT_RPC 0x04
72 #define NET_TRANSPORT_ADS 0x08
74 struct functable {
75 const char *funcname;
76 int (*fn)(struct net_context *c, int argc, const char **argv);
79 struct functable2 {
80 const char *funcname;
81 int (*fn)(struct net_context *c, int argc, const char **argv);
82 const char *helptext;
85 struct functable3 {
86 const char *funcname;
87 int (*fn)(struct net_context *c, int argc, const char **argv);
88 int valid_transports;
89 const char *description;
90 const char *usage;
93 typedef NTSTATUS (*rpc_command_fn)(struct net_context *c,
94 const DOM_SID *,
95 const char *,
96 struct cli_state *cli,
97 struct rpc_pipe_client *,
98 TALLOC_CTX *,
99 int,
100 const char **);
102 typedef struct copy_clistate {
103 TALLOC_CTX *mem_ctx;
104 struct cli_state *cli_share_src;
105 struct cli_state *cli_share_dst;
106 char *cwd;
107 uint16 attribute;
108 struct net_context *c;
109 }copy_clistate;
111 struct rpc_sh_ctx {
112 struct cli_state *cli;
114 DOM_SID *domain_sid;
115 const char *domain_name;
117 const char *whoami;
118 const char *thiscmd;
119 struct rpc_sh_cmd *cmds;
120 struct rpc_sh_ctx *parent;
123 struct rpc_sh_cmd {
124 const char *name;
125 struct rpc_sh_cmd *(*sub)(struct net_context *c,
126 TALLOC_CTX *mem_ctx,
127 struct rpc_sh_ctx *ctx);
128 int pipe_idx;
129 NTSTATUS (*fn)(struct net_context *c, TALLOC_CTX *mem_ctx,
130 struct rpc_sh_ctx *ctx,
131 struct rpc_pipe_client *pipe_hnd,
132 int argc, const char **argv);
133 const char *help;
136 enum netdom_domain_t { ND_TYPE_NT4, ND_TYPE_AD };
138 /* INCLUDE FILES */
140 #include "utils/net_proto.h"
141 #include "utils/net_help_common.h"
143 /* MACROS & DEFINES */
145 #define NET_FLAGS_MASTER 0x00000001
146 #define NET_FLAGS_DMB 0x00000002
147 #define NET_FLAGS_LOCALHOST_DEFAULT_INSANE 0x00000004 /* Would it be insane to set 'localhost'
148 as the default remote host for this
149 operation? For example, localhost
150 is insane for a 'join' operation. */
151 #define NET_FLAGS_PDC 0x00000008 /* PDC only */
152 #define NET_FLAGS_ANONYMOUS 0x00000010 /* use an anonymous connection */
153 #define NET_FLAGS_NO_PIPE 0x00000020 /* don't open an RPC pipe */
155 /* net share operation modes */
156 #define NET_MODE_SHARE_MIGRATE 1
158 /* Structure for mapping accounts to groups */
159 /* Array element is the group rid */
160 typedef struct _groupmap {
161 uint32 rid;
162 uint32 gidNumber;
163 fstring sambaSID;
164 fstring group_dn;
165 } GROUPMAP;
167 typedef struct _accountmap {
168 uint32 rid;
169 fstring cn;
170 } ACCOUNTMAP;