rpcclient(1) — Chainguard OS Manuals

RPCCLIENT(1)

User Commands

RPCCLIENT(1)

NAME

rpcclient - tool for executing client side MS-RPC functions

rpcclient [-c|--command=COMMANDS] [-I|--dest-ip=IP] [-p|--port=PORT] [-?|--help] [--usage] [-d|--debuglevel=DEBUGLEVEL] [--debug-stdout] [--configfile=CONFIGFILE] [--option=name=value] [-l|--log-basename=LOGFILEBASE] [--leak-report] [--leak-report-full] [-R|--name-resolve=NAME-RESOLVE-ORDER] [-O|--socket-options=SOCKETOPTIONS] [-m|--max-protocol=MAXPROTOCOL] [-n|--netbiosname=NETBIOSNAME] [--netbios-scope=SCOPE] [-W|--workgroup=WORKGROUP] [--realm=REALM] [-U|--user=[DOMAIN/]USERNAME[%PASSWORD]] [-N|--no-pass] [--password=STRING] [--pw-nt-hash] [-A|--authentication-file=FILE] [-P|--machine-pass] [--simple-bind-dn=DN] [--use-kerberos=desired|required|off] [--use-krb5-ccache=CCACHE] [--use-winbind-ccache] [--client-protection=sign|encrypt|off] [-V|--version] {BINDING-STRING|HOST}

DESCRIPTION

.PP This tool is part of the samba(7) suite.

.PP rpcclient is a utility initially developed to test MS-RPC functionality in Samba itself. It has undergone several stages of development and stability. Many system administrators have now written scripts around it to manage Windows NT clients from their UNIX workstation.

OPTIONS

.PP BINDING-STRING|HOST

When connecting to a dcerpc service you need to specify a binding string.

The format is:

TRANSPORT:host[options]

where TRANSPORT is either ncacn_np (named pipes) for SMB or ncacn_ip_tcp for DCERPC over TCP/IP.

"host" is an IP or hostname or netbios name. If the binding string identifies the server side of an endpoint, "host" may be an empty string. See below for more details.

"options" can include a SMB pipe name if using the ncacn_np transport or a TCP port number if using the ncacn_ip_tcp transport, otherwise they will be auto-determined.

Examples:

•ncacn_ip_tcp:samba.example.com[1024]

•ncacn_ip_tcp:samba.example.com[sign,seal,krb5]

•ncacn_ip_tcp:samba.example.com[sign,spnego]

•ncacn_np:samba.example.com

•ncacn_np:samba.example.com[samr]

•ncacn_np:samba.example.com[samr,sign,print]

•ncalrpc:/path/to/unix/socket

•//SAMBA

.sp

The supported transports are:

•ncacn_np - Connect using named pipes

•ncacn_ip_tcp - Connect over TCP/IP

•ncalrpc - Connect over local RPC (unix sockets)

.sp

The supported options are:

•sign - Use RPC integrity authentication level

•seal - Enable RPC privacy (encryption) authentication level

•connect - Use RPC connect level authentication (auth, but no sign or seal)

•packet - Use RPC packet authentication level

•spnego - Use SPNEGO instead of NTLMSSP authentication

•ntlm - Use plain NTLM instead of SPNEGO or NTLMSSP

•krb5 - Use Kerberos instead of NTLMSSP authentication

•schannel - Create a schannel connection

•smb1 - Use SMB1 for named pipes

•smb2 - Use SMB2/3 for named pipes

•validate - Enable the NDR validator

•print - Enable debug output of packets

•padcheck - Check reply data for non-zero pad bytes

•bigendian - Use big endian for RPC

•ndr64 - Use NDR64 for RPC

.sp

.RE

.PP -c|--command=<command string>

Execute semicolon separated commands (listed below)

.RE

.PP -I|--dest-ip IP-address

IP address is the address of the server to connect to. It should be specified in standard "a.b.c.d" notation.

Normally the client would attempt to locate a named SMB/CIFS server by looking it up via the NetBIOS name resolution mechanism described above in the name resolve order parameter above. Using this parameter will force the client to assume that the server is on the machine with the specified IP address and the NetBIOS name component of the resource being connected to will be ignored.

There is no default for this parameter. If not supplied, it will be determined automatically by the client as described above.

.RE

.PP -p|--port port

This number is the TCP port number that will be used when making connections to the server. The standard (well-known) TCP port number for an SMB/CIFS server is 139, which is the default.

.RE

-?|--help

Print a summary of command line options.

--usage

Display brief usage message.

-d|--debuglevel=level

level is an integer from 0 to 10. The default value if this parameter is not specified is 1 for client applications.

The higher this value, the more detail will be logged to the log files about the activities of the server. At level 0, only critical errors and serious warnings will be logged. Level 1 is a reasonable level for day-to-day running - it generates a small amount of information about operations carried out.

Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic.

Note that specifying this parameter here will override the log level parameter in the /etc/samba/smb.conf file.

--debug-stdout

This will redirect debug output to STDOUT. By default all clients are logging to STDERR.

--configfile=<configuration file>

The file specified contains the configuration details required by the client. The information in this file can be general for client and server or only provide client specific like options such as client smb encrypt. See /etc/samba/smb.conf for more information. The default configuration file name is determined at compile time.

--option=<name>=<value>

Set the smb.conf(5) option "<name>" to value "<value>" from the command line. This overrides compiled-in defaults and options read from the configuration file. If a name or a value includes a space, wrap whole --option=name=value into quotes.

-l|--log-basename=logdirectory

Base directory name for log/debug files. The extension ".progname" will be appended (e.g. log.smbclient, log.smbd, etc...). The log file is never removed by the client.

--leak-report

Enable talloc leak reporting on exit.

--leak-report-full

Enable full talloc leak reporting on exit.

-V|--version

Prints the program version number.

-R|--name-resolve=NAME-RESOLVE-ORDER

This option is used to determine what naming services and in what order to resolve host names to IP addresses. The option takes a space-separated string of different name resolution options. The best is to wrap the whole --name-resolve=NAME-RESOLVE-ORDER into quotes.

The options are: "lmhosts", "host", "wins" and "bcast". They cause names to be resolved as follows:

• lmhosts: Lookup an IP address in the Samba lmhosts file. If the line in lmhosts has no name type attached to the NetBIOS name (see the lmhosts(5) for details) then any name type matches for lookup.

.RE

• host: Do a standard host name to IP address resolution, using the system /etc/hosts, NIS, or DNS lookups. This method of name resolution is operating system dependent, for instance on IRIX or Solaris this may be controlled by the /etc/nsswitch.conf file). Note that this method is only used if the NetBIOS name type being queried is the 0x20 (server) name type, otherwise it is ignored.

.RE

• wins: Query a name with the IP address listed in the wins server parameter. If no WINS server has been specified this method will be ignored.

.RE

• bcast: Do a broadcast on each of the known local interfaces listed in the interfaces parameter. This is the least reliable of the name resolution methods as it depends on the target host being on a locally connected subnet.

.RE .sp

If this parameter is not set then the name resolve order defined in the /etc/samba/smb.conf file parameter (name resolve order) will be used.

The default order is lmhosts, host, wins, bcast. Without this parameter or any entry in the name resolve order parameter of the /etc/samba/smb.conf file, the name resolution methods will be attempted in this order.

-O|--socket-options=SOCKETOPTIONS

TCP socket options to set on the client socket. See the socket options parameter in the /etc/samba/smb.conf manual page for the list of valid options.

-m|--max-protocol=MAXPROTOCOL

The value of the parameter (a string) is the highest protocol level that will be supported by the client.

Note that specifying this parameter here will override the client max protocol parameter in the /etc/samba/smb.conf file.

-n|--netbiosname=NETBIOSNAME

This option allows you to override the NetBIOS name that Samba uses for itself. This is identical to setting the netbios name parameter in the /etc/samba/smb.conf file. However, a command line setting will take precedence over settings in /etc/samba/smb.conf.

--netbios-scope=SCOPE

This specifies a NetBIOS scope that nmblookup will use to communicate with when generating NetBIOS names. For details on the use of NetBIOS scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are very rarely used, only set this parameter if you are the system administrator in charge of all the NetBIOS systems you communicate with.

-W|--workgroup=WORKGROUP

Set the SMB domain of the username. This overrides the default domain which is the domain defined in smb.conf. If the domain specified is the same as the servers NetBIOS name, it causes the client to log on using the servers local SAM (as opposed to the Domain SAM).

Note that specifying this parameter here will override the workgroup parameter in the /etc/samba/smb.conf file.

-r|--realm=REALM

Set the realm for the domain.

Note that specifying this parameter here will override the realm parameter in the /etc/samba/smb.conf file.

-U|--user=[DOMAIN\]USERNAME[%PASSWORD]

Sets the SMB username or username and password.

If %PASSWORD is not specified, the user will be prompted. The client will first check the USER environment variable (which is also permitted to also contain the password separated by a %), then the LOGNAME variable (which is not permitted to contain a password) and if either exists, the value is used. If these environmental variables are not found, the username found in a Kerberos Credentials cache may be used.

A third option is to use a credentials file which contains the plaintext of the username and password. This option is mainly provided for scripts where the admin does not wish to pass the credentials on the command line or via environment variables. If this method is used, make certain that the permissions on the file restrict access from unwanted users. See the -A for more details.

Be cautious about including passwords in scripts or passing user-supplied values onto the command line. For security it is better to let the Samba client tool ask for the password if needed, or obtain the password once with kinit.

While Samba will attempt to scrub the password from the process title (as seen in ps), this is after startup and so is subject to a race.

-N|--no-pass

If specified, this parameter suppresses the normal password prompt from the client to the user. This is useful when accessing a service that does not require a password.

Unless a password is specified on the command line or this parameter is specified, the client will request a password.

If a password is specified on the command line and this option is also defined the password on the command line will be silently ignored and no password will be used.

--password

Specify the password on the commandline.

If --password is not specified, the tool will check the PASSWD environment variable, followed by PASSWD_FD which is expected to contain an open file descriptor (FD) number.

Finally it will check PASSWD_FILE (containing a file path to be opened). The file should only contain the password. Make certain that the permissions on the file restrict access from unwanted users!

While Samba will attempt to scrub the password from the process title (as seen in ps), this is after startup and so is subject to a race.

--pw-nt-hash

The supplied password is the NT hash.

-A|--authentication-file=filename

This option allows you to specify a file from which to read the username and password used in the connection. The format of the file is:

				username = <value>
				password = <value>
				domain   = <value>

Make certain that the permissions on the file restrict access from unwanted users!

-P|--machine-pass

Use stored machine account password.

--simple-bind-dn=DN

DN to use for a simple bind.

--use-kerberos=desired|required|off

This parameter determines whether Samba client tools will try to authenticate using Kerberos. For Kerberos authentication you should use DNS names instead of IP addresses when connecting to a service. By default Samba client tools will try to use the default Kerberos credential cache (ccache). In case the ccache does not exist or -U|--user option was specified, clients will ask to enter a password and will obtain a Kerberos ticket (kinit) for you. If you want to use an alternative Kerberos credentical cache, use the --use-krb5-ccache option.

Note that specifying this parameter here will override the client use kerberos parameter in the /etc/samba/smb.conf file.

--use-krb5-ccache=CCACHE

Specifies the credential cache location for Kerberos authentication.

This will enforce --use-kerberos=required.

--use-winbind-ccache

Try to use the credential cache by winbind.

--client-protection=sign|encrypt|off

Sets the connection protection the client tool should use.

Note that specifying this parameter here will override the client protection parameter in the /etc/samba/smb.conf file.

In case you need more fine grained control you can use: --option=clientsmbencrypt=OPTION, --option=clientipcsigning=OPTION, --option=clientsigning=OPTION.

COMMANDS

.SS "LSARPC"

.PP lsaquery

Query info policy

.PP lookupsids

Convert SIDs to names

.PP lookupsids3

Convert SIDs to names

.PP lookupsids_level

Convert SIDs to names

.PP lookupnames

Convert names to SIDs

.PP lookupnames4

Convert names to SIDs

.PP lookupnames_level

Convert names to SIDs

.PP enumtrust

Enumerate trusted domains

.PP enumprivs

Enumerate privileges

.PP getdispname

Get the privilege name

.PP lsaenumsid

Enumerate the LSA SIDS

.PP lsacreateaccount

Create a new lsa account

.PP lsaenumprivsaccount

Enumerate the privileges of an SID

.PP lsaenumacctrights

Enumerate the rights of an SID

.PP lsaaddpriv

Assign a privilege to a SID

.PP lsadelpriv

Revoke a privilege from a SID

.PP lsaaddacctrights

Add rights to an account

.PP lsaremoveacctrights

Remove rights from an account

.PP lsalookupprivvalue

Get a privilege value given its name

.PP lsaquerysecobj

Query LSA security object

.PP lsaquerytrustdominfo

Query LSA trusted domains info (given a SID)

.PP lsaquerytrustdominfobyname

Query LSA trusted domains info (given a name), only works for Windows > 2k

.PP lsaquerytrustdominfobysid

Query LSA trusted domains info (given a SID)

.PP lsasettrustdominfo

Set LSA trusted domain info

.PP getusername

Get username

.PP createsecret

Create Secret

.PP deletesecret

Delete Secret

.PP querysecret

Query Secret

.PP setsecret

Set Secret

.PP retrieveprivatedata

Retrieve Private Data

.PP storeprivatedata

Store Private Data

.PP createtrustdom

Create Trusted Domain

.PP deletetrustdom

Delete Trusted Domain

.SS "LSARPC-DS"

.PP dsroledominfo

Get Primary Domain Information

.SS "DFS"

.PP dfsversion

Query DFS support

.PP dfsadd

Add a DFS share

.PP dfsremove

Remove a DFS share

.PP dfsgetinfo

Query DFS share info

.PP dfsenum

Enumerate dfs shares

.PP dfsenumex

Enumerate dfs shares

.SS "SHUTDOWN"

.PP shutdowninit

syntax: shutdown [-m message]

.PP shutdownabort

syntax: shutdownabort

.SS "SRVSVC"

.PP srvinfo

Server query info

.PP netshareenum

Enumerate shares

.PP netshareenumall

Enumerate all shares

.PP netsharegetinfo

Get Share Info

.PP netsharesetinfo

Set Share Info

.PP netsharesetdfsflags

Set DFS flags

.PP netfileenum

Enumerate open files

.PP netremotetod

Fetch remote time of day

.PP netnamevalidate

Validate sharename

.PP netfilegetsec

Get File security

.PP netsessdel

Delete Session

.PP netsessenum

Enumerate Sessions

.PP netdiskenum

Enumerate Disks

.PP netconnenum

Enumerate Connections

.PP netshareadd

Add share

.PP netsharedel

Delete share

.SS "SAMR"

.PP queryuser

Query user info

.PP querygroup

Query group info

.PP queryusergroups

Query user groups

.PP queryuseraliases

Query user aliases

.PP querygroupmem

Query group membership

.PP queryaliasmem

Query alias membership

.PP queryaliasinfo

Query alias info

.PP deletealias

Delete an alias

.PP querydispinfo

Query display info

.PP querydispinfo2

Query display info

.PP querydispinfo3

Query display info

.PP querydominfo

Query domain info

.PP enumdomusers

Enumerate domain users

.PP enumdomgroups

Enumerate domain groups

.PP enumalsgroups

Enumerate alias groups

.PP enumdomains

Enumerate domains

.PP createdomuser

Create domain user

.PP createdomgroup

Create domain group

.PP createdomalias

Create domain alias

.PP samlookupnames

Look up names

.PP samlookuprids

Look up names

.PP deletedomgroup

Delete domain group

.PP deletedomuser

Delete domain user

.PP samquerysecobj

Query SAMR security object

.PP getdompwinfo

Retrieve domain password info

.PP getusrdompwinfo

Retrieve user domain password info

.PP lookupdomain

Lookup Domain Name

.PP chgpasswd

Change user password

.PP chgpasswd2

Change user password

.PP chgpasswd3

Change user password (RC4 encrypted)

.PP chgpasswd4

Change user password (AES encrypted)

.PP getdispinfoidx

Get Display Information Index

.PP setuserinfo

Set user info

.PP setuserinfo2

Set user info2

.SS "SPOOLSS"

.PP adddriver <arch> <config> [<version>]

Execute an AddPrinterDriver() RPC to install the printer driver information on the server. Note that the driver files should already exist in the directory returned by getdriverdir. Possible values for arch are the same as those for the getdriverdir command. The config parameter is defined as follows:

Long Driver Name:\
Driver File Name:\
Data File Name:\
Config File Name:\
Help File Name:\
Language Monitor Name:\
Default Data Type:\
Comma Separated list of Files

Any empty fields should be enter as the string "NULL".

Samba does not need to support the concept of Print Monitors since these only apply to local printers whose driver can make use of a bi-directional link for communication. This field should be "NULL". On a remote NT print server, the Print Monitor for a driver must already be installed prior to adding the driver or else the RPC will fail.

The version parameter lets you specify the printer driver version number. If omitted, the default driver version for the specified architecture will be used. This option can be used to upload Windows 2000 (version 3) printer drivers.

.PP addprinter <printername> <sharename> <drivername> <port>

Add a printer on the remote server. This printer will be automatically shared. Be aware that the printer driver must already be installed on the server (see adddriver) and the portmust be a valid port name (see enumports.

.RE

.PP deldriver <driver>

Delete the specified printer driver for all architectures. This does not delete the actual driver files from the server, only the entry from the server's list of drivers.

.PP deldriverex <driver> [architecture] [version] [flags]

Delete the specified printer driver and optionally files associated with the driver. You can limit this action to a specific architecture and a specific version. If no architecture is given, all driver files of that driver will be deleted. flags correspond to numeric DPD_* values, i.e. a value of 3 requests (DPD_DELETE_UNUSED_FILES | DPD_DELETE_SPECIFIC_VERSION).

.PP enumdata

Enumerate all printer setting data stored on the server. On Windows NT clients, these values are stored in the registry, while Samba servers store them in the printers TDB. This command corresponds to the MS Platform SDK GetPrinterData() function (* This command is currently unimplemented).

.PP enumdataex

Enumerate printer data for a key

.PP enumkey

Enumerate printer keys

.PP enumjobs <printer>

List the jobs and status of a given printer. This command corresponds to the MS Platform SDK EnumJobs() function

.PP getjob

Get print job

.PP setjob

Set print job

.PP enumports [level]

Executes an EnumPorts() call using the specified info level. Currently only info levels 1 and 2 are supported.

.PP enumdrivers [level]

Execute an EnumPrinterDrivers() call. This lists the various installed printer drivers for all architectures. Refer to the MS Platform SDK documentation for more details of the various flags and calling options. Currently supported info levels are 1, 2, and 3.

.PP enumprinters [level]

Execute an EnumPrinters() call. This lists the various installed and share printers. Refer to the MS Platform SDK documentation for more details of the various flags and calling options. Currently supported info levels are 1, 2 and 5.

.PP getdata <printername> <valuename;>

Retrieve the data for a given printer setting. See the enumdata command for more information. This command corresponds to the GetPrinterData() MS Platform SDK function.

.PP getdataex

Get printer driver data with keyname

.PP getdriver <printername>

Retrieve the printer driver information (such as driver file, config file, dependent files, etc...) for the given printer. This command corresponds to the GetPrinterDriver() MS Platform SDK function. Currently info level 1, 2, and 3 are supported.

.PP getdriverdir <arch>

Execute a GetPrinterDriverDirectory() RPC to retrieve the SMB share name and subdirectory for storing printer driver files for a given architecture. Possible values for arch are "Windows 4.0" (for Windows 95/98), "Windows NT x86", "Windows NT PowerPC", "Windows Alpha_AXP", and "Windows NT R4000".

.PP getdriverpackagepath

Get print driver package download directory

.PP getprinter <printername>

Retrieve the current printer information. This command corresponds to the GetPrinter() MS Platform SDK function.

.PP openprinter <printername>

Execute an OpenPrinterEx() and ClosePrinter() RPC against a given printer.

.PP openprinter_ex <printername>

Open printer handle

.PP setdriver <printername> <drivername>

Execute a SetPrinter() command to update the printer driver associated with an installed printer. The printer driver must already be correctly installed on the print server.

See also the enumprinters and enumdrivers commands for obtaining a list of of installed printers and drivers.

.PP getprintprocdir

Get print processor directory

.PP addform

Add form

.PP setform

Set form

.PP getform

Get form

.PP deleteform

Delete form

.PP enumforms

Enumerate form

.PP setprinter

Set printer comment

.PP setprinterdata

Set REG_SZ printer data

.PP setprintername <printername> <newprintername>

Set printer name

.PP rffpcnex

Rffpcnex test

.PP printercmp

Printer comparison test

.PP enumprocs

Enumerate Print Processors

.PP enumprocdatatypes

Enumerate Print Processor Data Types

.PP enummonitors

Enumerate Print Monitors

.PP createprinteric

Create Printer IC

.PP playgdiscriptonprinteric

Create Printer IC

.PP getcoreprinterdrivers

Get CorePrinterDriver

.PP enumpermachineconnections

Enumerate Per Machine Connections

.PP addpermachineconnection

Add Per Machine Connection

.PP delpermachineconnection

Delete Per Machine Connection

.SS "NETLOGON"

.PP logonctrl2

Logon Control 2

.PP getanydcname

Get trusted DC name

.PP getdcname

Get trusted PDC name

.PP dsr_getdcname

Get trusted DC name

.PP dsr_getdcnameex

Get trusted DC name

.PP dsr_getdcnameex2

Get trusted DC name

.PP dsr_getsitename

Get sitename

.PP dsr_getforesttrustinfo

Get Forest Trust Info

.PP logonctrl

Logon Control

.PP samlogon

Sam Logon

.PP change_trust_pw

Change Trust Account Password

.PP gettrustrid

Get trust rid

.PP dsr_enumtrustdom

Enumerate trusted domains

.PP dsenumdomtrusts

Enumerate all trusted domains in an AD forest

.PP deregisterdnsrecords

Deregister DNS records

.PP netrenumtrusteddomains

Enumerate trusted domains

.PP netrenumtrusteddomainsex

Enumerate trusted domains

.PP getdcsitecoverage

Get the Site-Coverage from a DC

.PP capabilities

Return Capabilities

.PP logongetdomaininfo

Return LogonGetDomainInfo

.SS "FSRVP"

.PP fss_is_path_sup

Check whether a share supports shadow-copy

.PP fss_get_sup_version

Get supported FSRVP version from server

.PP fss_create_expose

Request shadow-copy creation and exposure

.PP fss_delete

Request shadow-copy share deletion

.PP fss_has_shadow_copy

Check for an associated share shadow-copy

.PP fss_get_mapping

Get shadow-copy share mapping information

.PP fss_recovery_complete

Flag read-write snapshot as recovery complete,

.SS "CLUSAPI"

.PP clusapi_open_cluster

Open cluster

.PP clusapi_get_cluster_name

Get cluster name

.PP clusapi_get_cluster_version

Get cluster version

.PP clusapi_get_quorum_resource

Get quorum resource

.PP clusapi_create_enum

Create enum query

.PP clusapi_create_enumex

Create enumex query

.PP clusapi_open_resource

Open cluster resource

.PP clusapi_online_resource

Set cluster resource online

.PP clusapi_offline_resource

Set cluster resource offline

.PP clusapi_get_resource_state

Get cluster resource state

.PP clusapi_get_cluster_version2

Get cluster version2

.PP clusapi_pause_node

Pause cluster node

.PP clusapi_resume_node

Resume cluster node

.SS "DRSUAPI"

.PP dscracknames

Crack Name

.PP dsgetdcinfo

Get Domain Controller Info

.PP dsgetncchanges

Get NC Changes

.PP dswriteaccountspn

Write Account SPN

.SS "ECHO"

.PP echoaddone

Add one to a number

.PP echodata

Echo data

.PP sinkdata

Sink data

.PP sourcedata

Source data

.SS "EPMAPPER"

.PP epmmap

Map a binding

.PP epmlookup

Lookup bindings

.SS "EVENTLOG"

.PP eventlog_readlog

Read Eventlog

.PP eventlog_numrecord

Get number of records

.PP eventlog_oldestrecord

Get oldest record

.PP eventlog_reportevent

Report event

.PP eventlog_reporteventsource

Report event and source

.PP eventlog_registerevsource

.PP eventlog_backuplog

Backup Eventlog File

.PP eventlog_loginfo

Get Eventlog Information

.SS "IRemoteWinspool"

.PP winspool_AsyncOpenPrinter

Open printer handle

.PP winspool_AsyncCorePrinterDriverInstalled

Query Core Printer Driver Installed

.SS "NTSVCS"

.PP ntsvcs_getversion

Query NTSVCS version

.PP ntsvcs_validatedevinst

Query NTSVCS device instance

.PP ntsvcs_hwprofflags

Query NTSVCS HW prof flags

.PP ntsvcs_hwprofinfo

Query NTSVCS HW prof info

.PP ntsvcs_getdevregprop

Query NTSVCS device registry property

.PP ntsvcs_getdevlistsize

Query NTSVCS device list size

.PP ntsvcs_getdevlist

Query NTSVCS device list

.SS "MDSSVC"

.PP fetch_properties

Fetch connection properties

.PP fetch_attributes

Fetch attributes for a CNID

.SS "WINREG"

.PP winreg_enumkey

Enumerate Keys

.PP querymultiplevalues

Query multiple values

.PP querymultiplevalues2

Query multiple values

.SS "WITNESS"

.PP GetInterfaceList

List the interfaces to which witness client connections can be made

.PP Register

.PP UnRegister

Unregister for notifications from the server

.PP AsyncNotify

Request notification of registered resource changes from the server

.PP RegisterEx

.SS "WKSSVC"

.PP wkssvc_wkstagetinfo

Query WKSSVC Workstation Information

.PP wkssvc_getjoininformation

Query WKSSVC Join Information

.PP wkssvc_messagebuffersend

Send WKSSVC message

.PP wkssvc_enumeratecomputernames

Enumerate WKSSVC computer names

.PP wkssvc_enumerateusers

Enumerate WKSSVC users

.SS "GENERAL OPTIONS"

.PP help

Get help on commands

.PP ?

Get help on commands

.PP debuglevel

Set debug level

.PP debug

Set debug level

.PP list

List available commands on pipe

.PP exit

Exit program

.PP quit

Exit program

.PP sign

Force RPC pipe connections to be signed

.PP seal

Force RPC pipe connections to be sealed

.PP packet

Force RPC pipe connections with packet authentication level

.PP schannel

Force RPC pipe connections to be sealed with 'schannel'. Force RPC pipe connections to be sealed with 'schannel'. Assumes valid machine account to this domain controller.

.PP schannelsign

Force RPC pipe connections to be signed (not sealed) with 'schannel'. Assumes valid machine account to this domain controller.

.PP timeout

Set timeout (in milliseconds) for RPC operations

.PP transport

Choose ncacn transport for RPC operations

.PP none

Force RPC pipe connections to have no special properties

BUGS

.PP rpcclient is designed as a developer testing tool and may not be robust in certain areas (such as command line parsing). It has been known to generate a core dump upon failures when invalid parameters were passed to the interpreter.

.PP From Luke Leighton's original rpcclient man page:

.PP WARNING! The MSRPC over SMB code has been developed from examining Network traces. No documentation is available from the original creators (Microsoft) on how MSRPC over SMB works, or how the individual MSRPC services work. Microsoft's implementation of these services has been demonstrated (and reported) to be... a bit flaky in places.

.PP The development of Samba's implementation is also a bit rough, and as more of the services are understood, it can even result in versions of smbd(8) and rpcclient(1) that are incompatible for some commands or services. Additionally, the developers are sending reports to Microsoft, and problems found or reported to Microsoft are fixed in Service Packs, which may result in incompatibilities.

VERSION

.PP This man page is part of version 4.25.1 of the Samba suite.

AUTHOR

.PP The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed.

.PP The original rpcclient man page was written by Matthew Geddes, Luke Kenneth Casson Leighton, and rewritten by Gerald Carter. The conversion to DocBook for Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done by Alexander Bokovoy.

11/05/2026

Samba 4.25.1