xp_cmdshell (Transact-SQL)

Artikel
12/15/2008

Erzeugt eine Windows-Befehlsshell und übergibt eine Zeichenfolge für die Ausführung. Die Ausgabe wird ggf. in Textzeilen zurückgegeben.

Themenlink (Symbol) Transact-SQL-Syntaxkonventionen

Syntax

xp_cmdshell { 'command_string' } [ , no_output ]

Argumente

'command_string'
Die Zeichenfolge, die einen an das Betriebssystem zu übergebenden Befehl enthält. command_string ist vom Datentyp varchar(8000) oder nvarchar(4000) und hat keinen Standardwert. command_string darf maximal einen Satz doppelter Anführungszeichen enthalten. Wenn Leerzeichen in den Dateipfaden oder Programmnamen enthalten sind, auf die von command_string verwiesen wird, ist ein einzelnes Paar Anführungszeichen erforderlich. Wenn Probleme mit eingebetteten Leerzeichen auftreten, sollten Sie FAT 8.3-Dateinamen verwenden, um dieses Problem zu umgehen.

no_output
Ein optionaler Parameter, der angibt, dass keine Ausgabe an den Client zurückgegeben werden soll.

Rückgabecodewerte

0 (Erfolg) oder 1 (Fehler)

Resultsets

Mit der folgenden xp_cmdshell-Anweisung wird eine Verzeichnisaufstellung des aktuellen Verzeichnisses zurückgegeben.

EXEC xp_cmdshell 'dir *.exe';
GO

Die Zeilen werden in einer Spalte vom Datentyp nvarchar(255) zurückgegeben. Falls die no_output-Option verwendet wird, wird nur Folgendes zurückgegeben:

The command(s) completed successfully.

Hinweise

Der von xp_cmdshell erzeugte Windows-Prozess besitzt dieselben Sicherheitsrechte wie das SQL Server-Dienstkonto.

xp_cmdshell wird synchron ausgeführt. Die Steuerung wird erst dann an den Aufrufer zurückgegeben, wenn der Befehl der Befehlsshell abgeschlossen wurde.

xp_cmdshell kann mithilfe des Tools für die Oberflächenkonfiguration und durch Ausführen von sp_configure aktiviert und deaktiviert werden. Weitere Informationen finden Sie unter Oberflächenkonfiguration und xp_cmdshell (Option).

Wichtig:
Falls xp_cmdshell innerhalb eines Batches ausgeführt wird und einen Fehler zurückgibt, erzeugt der Batch einen Fehler. Dieses Verhalten wurde geändert. In früheren Versionen von Microsoft SQL Server wurde der Batch weiterhin ausgeführt.

xp_cmdshell-Proxykonto

Wenn ein Benutzer, der nicht Mitglied der festen Serverrolle sysadmin ist, xp_cmdshell aufruft, wird eine Verbindung mit Windows mithilfe des Kontonamens und Kennwortes hergestellt, die in den Anmeldeinformationen mit dem Namen ##xp_cmdshell_proxy_account## gespeichert sind. Falls diese Proxyanmeldeinformationen nicht vorhanden sind, erzeugt xp_cmdshell einen Fehler.

Die Proxykonto-Anmeldeinformationen können durch Ausführen von sp_xp_cmdshell_proxy_account erstellt werden. Als Argumente besitzt diese gespeicherte Prozedur einen Windows-Benutzernamen und ein Kennwort. Mit dem folgenden Befehl werden z. B. Proxyanmeldeinformationen für den Windows-Domänenbenutzer SHIPPING\KobeR erstellt, der das Windows-Kennwort sdfh%dkc93vcMt0 besitzt.

EXEC sp_xp_cmdshell_proxy_account 'SHIPPING\KobeR','sdfh%dkc93vcMt0'

Weitere Informationen finden Sie unter sp_xp_cmdshell_proxy_account (Transact-SQL).

Berechtigungen

Erfordert die CONTROL SERVER-Berechtigung.

Beispiele

A. Zurückgeben einer Liste der ausführbaren Dateien

Im folgenden Beispiel wird mithilfe der erweiterten gespeicherten Prozedur xp_cmdshell der Befehl DIR ausgeführt.

EXEC master..xp_cmdshell 'dir *.exe'

B. Verwenden der NET-Befehle von Windows

Im folgenden Beispiel wird die Verwendung von xp_cmdshell in einer gespeicherten Prozedur veranschaulicht. In diesem Beispiel werden Benutzer mithilfe von net send darüber benachrichtigt, dass eine Instanz von SQL Server bald heruntergefahren wird. Der Server wird mithilfe von net pause angehalten und anschließend mithilfe von net stop heruntergefahren.

CREATE PROC shutdown10
AS
    EXEC xp_cmdshell 'net send /domain:SQL_USERS ''SQL Server 
        shutting down in 10 minutes. No more connections 
        allowed.', no_output
    EXEC xp_cmdshell 'net pause sqlserver'
    WAITFOR DELAY '00:05:00'
    EXEC xp_cmdshell 'net send /domain: SQL_USERS ''SQL Server 
        shutting down in 5 minutes.', no_output
    WAITFOR DELAY '00:04:00'
    EXEC xp_cmdshell 'net send /domain:SQL_USERS ''SQL Server 
        shutting down in 1 minute. Log off now.', no_output
    WAITFOR DELAY '00:01:00'
    EXEC xp_cmdshell 'net stop sqlserver', no_output

C. Unterdrücken der Ausgabe

Im folgenden Beispiel wird mit xp_cmdshell eine Befehlszeichenfolge ausgeführt, ohne dass die Ausgabe an den Client zurückgegeben wird.

USE master;
EXEC xp_cmdshell 'copy c:\SQLbcks\AdvWorks.bck
    \\server2\backups\SQLbcks, NO_OUTPUT';
GO

D. Verwenden des Rückgabestatus

Im folgenden Beispiel wird von der erweiterten gespeicherten Prozedur xp_cmdshell auch der Rückgabestatus vorgeschlagen. Der Rückgabecodewert wird in der Variablen @result gespeichert.

DECLARE @result int
EXEC @result = xp_cmdshell 'dir *.exe'
IF (@result = 0)
   PRINT 'Success'
ELSE
   PRINT 'Failure'

E. Schreiben des Inhalts von Variablen in eine Datei

Im folgenden Beispiel wird der Inhalt der @var-Variablen in die Datei var_out.txt im aktuellen Serververzeichnis geschrieben.

DECLARE @cmd sysname, @var sysname
SET @var = 'Hello world'
SET @cmd = 'echo ' + @var + ' > var_out.txt'
EXEC master..xp_cmdshell @cmd

F. Aufzeichnen des Ergebnisses eines Befehls in einer Datei

Im folgenden Beispiel wird der Inhalt des aktuellen Verzeichnisses in die Datei dir_out.txt im aktuellen Serververzeichnis geschrieben.

DECLARE @cmd sysname, @var sysname
SET @var = 'dir/p'
SET @cmd = @var + ' > dir_out.txt'
EXEC master..xp_cmdshell @cmd

Siehe auch

Freigeben über