Get-WSManInstance
Published: February 29, 2012
Updated: August 15, 2012
Applies To: Windows PowerShell 2.0, Windows PowerShell 3.0
Get-WSManInstance
Syntax
Parameter Set: GetInstance Get-WSManInstance [-ResourceURI] <Uri> [-ApplicationName <String> ] [-Authentication <AuthenticationMechanism> ] [-CertificateThumbprint <String> ] [-ComputerName <String> ] [-ConnectionURI <Uri> ] [-Credential <PSCredential> ] [-Dialect <Uri> ] [-Fragment <String> ] [-OptionSet <Hashtable> ] [-Port <Int32> ] [-SelectorSet <Hashtable> ] [-SessionOption <SessionOption> ] [-UseSSL] [ <CommonParameters>] Parameter Set: Enumerate Get-WSManInstance [-ResourceURI] <Uri> -Enumerate [-ApplicationName <String> ] [-Associations] [-Authentication <AuthenticationMechanism> ] [-BasePropertiesOnly] [-CertificateThumbprint <String> ] [-ComputerName <String> ] [-ConnectionURI <Uri> ] [-Credential <PSCredential> ] [-Dialect <Uri> ] [-Filter <String> ] [-OptionSet <Hashtable> ] [-Port <Int32> ] [-ReturnType <String> ] [-SessionOption <SessionOption> ] [-Shallow] [-UseSSL] [ <CommonParameters>]
Detailed Description
The Get-WSManInstance cmdlet retrieves an instance of a management resource that is specified by a resource URI. The information that is retrieved can be a complex XML information set (an object) or a simple value. This cmdlet is the equivalent to the standard WS-Management Get command.
This cmdlet uses the WS-Management connection/transport layer to retrieve information.
Parameters
-ApplicationName<String>
Specifies the application name in the connection. The default value of the ApplicationName parameter is "WSMAN". The complete identifier for the remote endpoint is in the following format:
<transport>://<server>:<port>/<ApplicationName>
For example:
http://server01:8080/WSMAN
Internet Information Services (IIS), which hosts the session, forwards requests with this endpoint to the specified application. This default setting of "WSMAN" is appropriate for most uses. This parameter is designed to be used when numerous computers establish remote connections to one computer that is running Windows PowerShell. In this case, IIS hosts Web Services for Management (WS-Management) for efficiency.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
wsman |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-Associations
Indicates that association instances (not associated instances) should be retrieved. You can use this parameter only when the Dialect parameter is set to a value of "Association".
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-Authentication<AuthenticationMechanism>
Specifies the authentication mechanism to be used at the server. Possible values are:
- Basic: Basic is a scheme in which the user name and password are sent in clear text to the server or proxy.
- Default : Use the authentication method implemented by the WS-Management protocol. This is the default.
- Digest: Digest is a challenge-response scheme that uses a server-specified data string for the challenge.
- Kerberos: The client computer and the server mutually authenticate by using Kerberos certificates.
- Negotiate: Negotiate is a challenge-response scheme that negotiates with the server or proxy to determine the scheme to use for authentication. For example, this parameter value allows negotiation to determine whether the Kerberos protocol or NTLM is used.
- CredSSP: Use Credential Security Support Provider (CredSSP) authentication, which allows the user to delegate credentials. This option is designed for commands that run on one remote computer but collect data from or run additional commands on other remote computers.
Caution: CredSSP delegates the user's credentials from the local computer to a remote computer. This practice increases the security risk of the remote operation. If the remote computer is compromised, when credentials are passed to it, the credentials can be used to control the network session.
|
Aliases |
auth,am |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
Default |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-BasePropertiesOnly
Enumerates only the properties that are part of the base class that is specified by the ResourceURI parameter. This parameter has no effect if the Shallow parameter is specified.
|
Aliases |
UBPO,Base |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-CertificateThumbprint<String>
Specifies the digital public key certificate (X509) of a user account that has permission to perform this action. Enter the certificate thumbprint of the certificate.
Certificates are used in client certificate-based authentication. They can be mapped only to local user accounts; they do not work with domain accounts.
To get a certificate thumbprint, use the Get-Item or Get-ChildItem command in the Windows PowerShell Cert: drive.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-ComputerName<String>
Specifies the computer against which you want to run the management operation. The value can be a fully qualified domain name, a NetBIOS name, or an IP address. Use the local computer name, use localhost, or use a dot (.) to specify the local computer. The local computer is the default. When the remote computer is in a different domain from the user, you must use a fully qualified domain name must be used. You can pipe a value for this parameter to the cmdlet.
|
Aliases |
CN |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
localhost |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-ConnectionURI<Uri>
Specifies the connection endpoint. The format of this string is:
<Transport>://<Server>:<Port>/<ApplicationName>
The following string is a properly formatted value for this parameter:
http://Server01:8080/WSMAN
The URI must be fully qualified.
|
Aliases |
CURI,CU |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-Credential<PSCredential>
Specifies a user account that has permission to perform this action. The default is the current user. Type a user name, such as "User01", "Domain01\User01", or "User@Domain.com". Or, enter a PSCredential object, such as one returned by the Get-Credential cmdlet. When you type a user name, you will be prompted for a password.
|
Aliases |
cred,c |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
True (ByPropertyName) |
|
Accept Wildcard Characters? |
false |
-Dialect<Uri>
Specifies the dialect to use in the filter predicate. This can be any dialect that is supported by the remote service. The following aliases can be used for the dialect URI:
- WQL: http://schemas.microsoft.com/wbem/wsman/1/WQL
- Selector: http://schemas.microsoft.com/wbem/wsman/1/wsman/SelectorFilter
- Association: http://schemas.dmtf.org/wbem/wsman/1/cimbinding/associationFilter
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
http://schemas.microsoft.com/wbem/wsman/1/WQL |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-Enumerate
Returns all of the instances of a management resource.
|
Aliases |
none |
|
Required? |
true |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-Filter<String>
Specifies the filter expression for the enumeration. If you use this parameter, you must also specify the Dialect parameter.
The valid values of this parameter depend on the dialect that is specified in the Dialect parameter. For example, if the Dialect parameter is set to WQL, the Filter parameter must contain a string, and the string must contain a valid WQL query such as the following query:
"Select * from Win32_Service where State != Running"
If the Dialect parameter is set to Association, the Filter parameter must contain a string, and the string must contain a valid filter, such as the following filter:
-filter:Object=EPR[;AssociationClassName=AssocClassName][;ResultClassName=ClassName][;Role=RefPropertyName][;ResultRole=RefPropertyName]}
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-Fragment<String>
Specifies a section inside the instance that is to be updated or retrieved for the specified operation. For example, to get the status of a spooler service, specify "-Fragment Status".
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-OptionSet<Hashtable>
Passes a set of switches to a service to modify or refine the nature of the request. These are similar to switches used in command-line shells because they are service specific. Any number of options can be specified.
The following example demonstrates the syntax that passes the values 1, 2, and 3 for the a, b, and c parameters:
-OptionSet @{a=1;b=2;c=3}
|
Aliases |
OS |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
|
Accept Wildcard Characters? |
false |
-Port<Int32>
Specifies the port to use when the client connects to the WinRM service. When the transport is HTTP, the default port is 80. When the transport is HTTPS, the default port is 443. When you use HTTPS as the transport, the value of the ComputerName parameter must match the server's certificate common name (CN). However, if the SkipCNCheck parameter is specified as part of the SessionOption parameter, then the certificate common name of the server does not have to match the host name of the server. The SkipCNCheck parameter should be used only for trusted computers.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-ResourceURI<Uri>
Contains the Uniform Resource Identifier (URI) of the resource class or instance. The URI is used to identify a specific type of resource, such as disks or processes, on a computer.
A URI consists of a prefix and a path to a resource. For example:
http://schemas.microsoft.com/wbem/wsman/1/wmi/root/cimv2/Win32_LogicalDisk
http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_NumericSensor
|
Aliases |
RURI |
|
Required? |
true |
|
Position? |
1 |
|
Default Value |
none |
|
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
|
Accept Wildcard Characters? |
false |
-ReturnType<String>
Specifies the type of data to be returned. The valid values are:
Object (the default)
EPR
ObjectAndEPR
If Object is specified or if this parameter is not used, only objects are returned. If EPR (endpoint reference) is specified, only the endpoint references of the objects are returned. Endpoint references contain information about the resource URI and the selectors for the instance. If ObjectAndEPR is specified, both the object and its associated endpoint references are returned.
|
Aliases |
RT |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
Object |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-SelectorSet<Hashtable>
Specifies a set of value pairs that are used to select particular management resource instances. The SelectorSet parameter is used when more than one instance of the resource exists. The value of the SelectorSet parameter must be a hash table.
The following example shows how to enter a value for this parameter:
-SelectorSet @{Name="WinRM";ID="yyy"}
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-SessionOption<SessionOption>
Defines a set of extended options for the WS-Management session. Enter a SessionOption object that you create by using the New-WSManSessionOption cmdlet. For more information about the options that are available, see New-WSManSessionOption.
|
Aliases |
SO |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-Shallow
Causes only instances of the base class that is specified in the resource URI to be returned. If this switch is not specified, instances of the base class that is specified in the URI and in all its derived classes is returned.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-UseSSL
Specifies that the Secure Sockets Layer (SSL) protocol should be used to establish a connection to the remote computer. By default, SSL is not used.
WS-Management encrypts all the Windows PowerShell content that is transmitted over the network. The UseSSL parameter lets you specify the additional protection of HTTPS instead of HTTP. If SSL is not available on the port that is used for the connection and you specify this parameter, the command fails.
|
Aliases |
SSL |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
-
None
This command does not accept any input.
Outputs
The output type is the type of the objects that the cmdlet emits.
-
System.Xml.XmlElement
The Get-WSManInstance cmdlet generates an XMLElement object.
Examples
-------------------------- EXAMPLE 1 --------------------------
This command returns all of the information that Windows Management Instrumentation (WMI) exposes about the WinRM service on the remote server01 computer.
PS C:\> get-wsmaninstance wmicimv2/win32_service -selectorset @{name="winrm"} -computername server01xsi : http://www.w3.org/2001/XMLSchema-instancep : http://schemas.microsoft.com/wbem/wsman/1/wmi/root/cimv2/Win32_Servicecim : http://schemas.dmtf.org/wbem/wscim/1/commontype : p:Win32_Service_Typelang : en-USAcceptPause : falseAcceptStop : trueCaption : Windows Remote Management (WS-Management)CheckPoint : 0CreationClassName : Win32_ServiceDescription : Windows Remote Management (WinRM) service implements the WS-Management protocol for remotemanagement. WS-Management is a standard web services protocol used for remote software andhardware management. The WinRM service listens on the network for WS-Management requestsand processes them. The WinRM Service needs to be configured with a listener using thewinrm.cmd command line tool or through Group Policy in order for it to listen over thenetwork. The WinRM service provides access to WMI data and enables event collection. Eventcollection and subscription to events require that the service is running. WinRM messagesuse HTTP and HTTPS as transports. The WinRM service does not depend on IIS but ispreconfigured to share a port with IIS on the same machine. The WinRM service reserves the/wsman URL prefix. To prevent conflicts with IIS, administrators should ensure that anywebsites hosted on IIS do not use the /wsman URL prefix.DesktopInteract : falseDisplayName : Windows Remote Management (WS-Management)ErrorControl : NormalExitCode : 0InstallDate : InstallDateName : winrmPathName : C:\Windows\System32\svchost.exe -k NetworkServiceProcessId : 948ServiceSpecificExitCode : 0ServiceType : Share ProcessStarted : trueStartMode : AutoStartName : NT AUTHORITY\NetworkServiceState : RunningStatus : OKSystemCreationClassName : Win32_ComputerSystemSystemName : SERVER01TagId : 0WaitHint : 0
-------------------------- EXAMPLE 2 --------------------------
This command returns only the status of the Spooler service on the remote server01 computer.
PS C:\> get-wsmaninstance wmicimv2/win32_service -selectorset @{name="spooler"} -fragment status -computername server01XmlFragment=OK
-------------------------- EXAMPLE 3 --------------------------
This command returns endpoint references that correspond to all the services on the local computer.
PS C:\> get-wsmaninstance -enumerate wmicimv2/win32_service -returntype eprxsi : http://www.w3.org/2001/XMLSchema-instancep : http://schemas.microsoft.com/wbem/wsman/1/wmi/root/cimv2/Win32_Servicecim : http://schemas.dmtf.org/wbem/wscim/1/commontype : p:Win32_Service_Typelang : en-USAcceptPause : falseAcceptStop : falseCaption : Visual Studio 2008 Remote DebuggerCheckPoint : 0CreationClassName : Win32_ServiceDescription : Allows members of the Administrators group to remotely debug server applications using VisualStudio 2008. Use the Visual Studio 2008 Remote Debugging Configuration Wizard to enable thisservice.DesktopInteract : falseDisplayName : Visual Studio 2008 Remote DebuggerErrorControl : IgnoreExitCode : 1077InstallDate : InstallDateName : msvsmon90PathName : "C:\Program Files\Microsoft Visual Studio 9.0\Common7\IDE\Remote Debugger\x86\msvsmon.exe" /service msvsmon90ProcessId : 0ServiceSpecificExitCode : 0ServiceType : Own ProcessStarted : falseStartMode : DisabledStartName : LocalSystemState : StoppedStatus : OKSystemCreationClassName : Win32_ComputerSystemSystemName : COMPUTER01TagId : 0WaitHint : 0...
-------------------------- EXAMPLE 4 --------------------------
This command lists all of the services that meet the following criteria on the remote server01 computer:
- The startup type of the service is "Automatic".
- The service is stopped.
PS C:\> Get-WSManInstance -Enumerate wmicimv2/* -filter "select * from win32_service where StartMode = 'Auto' and State = 'Stopped'" -computername server01xsi : http://www.w3.org/2001/XMLSchema-instancep : http://schemas.microsoft.com/wbem/wsman/1/wmi/root/cimv2/Win32_Servicecim : http://schemas.dmtf.org/wbem/wscim/1/commontype : p:Win32_Service_Typelang : en-USAcceptPause : falseAcceptStop : falseCaption : Windows Media Center Service LauncherCheckPoint : 0CreationClassName : Win32_ServiceDescription : Starts Windows Media Center Scheduler and Windows Media Center Receiver servicesat startup if TV is enabled within Windows Media Center.DesktopInteract : falseDisplayName : Windows Media Center Service LauncherErrorControl : IgnoreExitCode : 0InstallDate : InstallDateName : ehstartPathName : C:\Windows\system32\svchost.exe -k LocalServiceNoNetworkProcessId : 0ServiceSpecificExitCode : 0ServiceType : Share ProcessStarted : falseStartMode : AutoStartName : NT AUTHORITY\LocalServiceState : StoppedStatus : OKSystemCreationClassName : Win32_ComputerSystemSystemName : Server01TagId : 0WaitHint : 0...
-------------------------- EXAMPLE 5 --------------------------
This command lists the WS-Management listener configuration on the local computer for the listener that matches the criteria in the selector set.
PS C:\> get-wsmaninstance winrm/config/listener -selectorset @{Address="*";Transport="http"}cfg : http://schemas.microsoft.com/wbem/wsman/1/config/listenerxsi : http://www.w3.org/2001/XMLSchema-instancelang : en-USAddress : *Transport : HTTPPort : 80Hostname :Enabled : trueURLPrefix : wsmanCertificateThumbprint :ListeningOn : {100.0.0.1, 123.123.123.123, ::1, 2001:4898:0:fff:0:5efe:123.123.123.123...}
-------------------------- EXAMPLE 6 --------------------------
This command lists the WS-Management listener configuration on the remote server01 computer for the listener that matches the criteria in the selector set.
PS C:\> get-wsmaninstance winrm/config/listener -selectorset @{Address="*";Transport="http"} -computername server01cfg : http://schemas.microsoft.com/wbem/wsman/1/config/listenerxsi : http://www.w3.org/2001/XMLSchema-instancelang : en-USAddress : *Transport : HTTPPort : 80Hostname :Enabled : trueURLPrefix : wsmanCertificateThumbprint :ListeningOn : {100.0.0.1, 123.123.123.124, ::1, 2001:4898:0:fff:0:5efe:123.123.123.124...}
-------------------------- EXAMPLE 7 --------------------------
This command gets the associated instances that are related to the specified instance (winrm).
Important: You must enclose the filter in quotation marks, as shown in the example.
PS C:\> Get-WSManInstance -Enumerate -Dialect association -filter "{Object=win32_service?name=winrm}" -res wmicimv2/*xsi : http://www.w3.org/2001/XMLSchema-instancep : http://schemas.microsoft.com/wbem/wsman/1/wmi/root/cimv2/Win32_ComputerSystemcim : http://schemas.dmtf.org/wbem/wscim/1/commontype : p:Win32_ComputerSystem_Typelang : en-USAdminPasswordStatus : 1AutomaticManagedPagefile : trueAutomaticResetBootOption : trueAutomaticResetCapability : trueBootOptionOnLimit : BootOptionOnLimitBootOptionOnWatchDog : BootOptionOnWatchDogBootROMSupported : trueBootupState : Normal bootCaption : SERVER01ChassisBootupState : 3CreationClassName : Win32_ComputerSystemCurrentTimeZone : -480DaylightInEffect : falseDescription : AT/AT COMPATIBLEDNSHostName : server01Domain : site01.corp.fabrikam.comDomainRole : 1EnableDaylightSavingsTime : trueFrontPanelResetStatus : 2InfraredSupported : falseInstallDate : InstallDateKeyboardPasswordStatus : 2LastLoadInfo : LastLoadInfoManufacturer : Dell Inc.Model : OptiPlex 745Name : SERVER01NameFormat : NameFormatNetworkServerModeEnabled : trueNumberOfLogicalProcessors : 2NumberOfProcessors : 1OEMStringArray : www.dell.comPartOfDomain : truePauseAfterReset : -1PCSystemType : 5PowerManagementSupported : PowerManagementSupportedPowerOnPasswordStatus : 1PowerState : 0PowerSupplyState : 3PrimaryOwnerContact : PrimaryOwnerContactPrimaryOwnerName : testuser01ResetCapability : 1ResetCount : -1ResetLimit : -1Roles : {LM_Workstation, LM_Server, SQLServer, NT}Status : OKSystemStartupDelay : SystemStartupDelaySystemStartupSetting : SystemStartupSettingSystemType : X86-based PCThermalState : 3TotalPhysicalMemory : 3217760256UserName : FABRIKAM\testuser01WakeUpType : 6Workgroup : Workgroupxsi : http://www.w3.org/2001/XMLSchema-instancep : http://schemas.microsoft.com/wbem/wsman/1/wmi/root/cimv2/Win32_Servicecim : http://schemas.dmtf.org/wbem/wscim/1/commontype : p:Win32_Service_Typelang : en-USAcceptPause : falseAcceptStop : falseCaption : Remote Procedure Call (RPC)CheckPoint : 0CreationClassName : Win32_ServiceDescription : Serves as the endpoint mapper and COM Service Control Manager. If this service is stoppedor disabled, programs using COM or Remote Procedure Call (RPC) services will not functionproperly.DesktopInteract : falseDisplayName : Remote Procedure Call (RPC)ErrorControl : NormalExitCode : 0InstallDate : InstallDateName : RpcSsPathName : C:\Windows\system32\svchost.exe -k rpcssProcessId : 1100ServiceSpecificExitCode : 0ServiceType : Share ProcessStarted : trueStartMode : AutoStartName : NT AUTHORITY\NetworkServiceState : RunningStatus : OKSystemCreationClassName : Win32_ComputerSystemSystemName : SERVER01TagId : 0WaitHint : 0xsi : http://www.w3.org/2001/XMLSchema-instancep : http://schemas.microsoft.com/wbem/wsman/1/wmi/root/cimv2/Win32_SystemDrivercim : http://schemas.dmtf.org/wbem/wscim/1/commontype : p:Win32_SystemDriver_Typelang : en-USAcceptPause : falseAcceptStop : trueCaption : HTTPCreationClassName : Win32_SystemDriverDescription : HTTPDesktopInteract : falseDisplayName : HTTPErrorControl : NormalExitCode : 0InstallDate : InstallDateName : HTTPPathName : C:\Windows\system32\drivers\HTTP.sysServiceSpecificExitCode : 0ServiceType : Kernel DriverStarted : trueStartMode : ManualStartName :State : RunningStatus : OKSystemCreationClassName : Win32_ComputerSystemSystemName : SERVER01TagId : 0
-------------------------- EXAMPLE 8 --------------------------
This command gets association instances that are related to the specified instance (winrm). Because the Dialect parameter is set to "association" and the Associations parameter is used, this command returns association instances, not associated instances.
Important: You must enclose the filter in quotation marks, as shown in the example.
PS C:\> Get-WSManInstance -Enumerate -Dialect association -Associations -filter "{Object=win32_service?name=winrm}" -res wmicimv2/*
Related topics