powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Get-WSManInstance



NAME
Get-WSManInstance

SYNOPSIS
Displays management information for a resource instance specified by a Resource URI.

SYNTAX
Get-WSManInstance -SelectorSet [-ApplicationName ] [-ComputerName ] [-Credential dential>] [-Fragment ] [-Port ] [-UseSSL] [-ResourceURI] [-Authentication ] [-Di
alect ] [-OptionSet ] [-SessionOption ] []

Get-WSManInstance [-ApplicationName ] [-BasePropertiesOnly ] [-ComputerName ] [-Credential
] [-Enumerate] [-filter ] [-Port ] [-References ] [-ReturnType ] [-Shall
ow ] [-UseSSL] [-ResourceURI] [-Authentication ] [-Dialect ] [-OptionSet ble>] [-SessionOption ] []

Get-WSManInstance -ConnectionURI -SelectorSet [-Fragment ] [-ResourceURI] [-Authent
ication ] [-Dialect ] [-OptionSet ] [-SessionOption ] [ >]

Get-WSManInstance -ConnectionURI [-BasePropertiesOnly ] [-Enumerate] [-filter ] [-References
] [-ReturnType ] [-Shallow ] [-ResourceURI] [-Authentication ] [-Dial
ect ] [-OptionSet ] [-SessionOption ] []


DESCRIPTION
The Get-WSManInstance cmdlet retrieves an instance of a management resource that is specified by a resource URI. Th
e 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
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:

://:/

For example:

http://server01:8080/WSMAN

Internet Information Services (IIS), which hosts the session, forwards requests with this endpoint to the speci
fied application. This default setting of "WSMAN" is appropriate for most uses. This parameter is designed to b
e 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.

Required? false
Position? named
Default value wsman
Accept pipeline input? false
Accept wildcard characters? false

-Authentication
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 th
e Kerberos protocol or NTLM is used.
- CredSSP: Use Credential Security Service 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 i
ncreases 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.

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.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-ComputerName
Specifies the computer against which you want to run the management operation. The value can be a fully qualifi
ed 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 do
main from the user, you must use a fully qualified domain name must be used. You can pipe a value for this para
meter to the cmdlet.

Required? false
Position? named
Default value localhost
Accept pipeline input? false
Accept wildcard characters? false

-ConnectionURI
Specifies the connection endpoint. The format of this string is:

://:/

The following string is a properly formatted value for this parameter:

http://Server01:8080/WSMAN

The URI must be fully qualified.

Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Credential
Specifies a user account that has permission to perform this action. The default is the current user. Type a us
er name, such as "User01", "Domain01\User01", or "User@Domain.com". Or, enter a PSCredential object, such as on
e returned by the Get-Credential cmdlet. When you type a user name, you will be prompted for a password.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Dialect
Specifies the dialect to use in the filter predicate. This can be any dialect that is supported by the remote s
ervice. 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

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.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-filter
Specifies the filter expression for the enumeration. If you use this parameter, you must also specify the Diale
ct parameter.

The valid values of this parameter depend on the dialect that is specified in the Dialect parameter. For exampl
e, if the Dialect parameter is set to WQL, the Filter parameter must contain a string, and the string must cont
ain 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][;Re
sultRole=RefPropertyName]}

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Fragment
Specifies a section inside the instance that is to be updated or retrieved for the specified operation. For exa
mple, to get the status of a spooler service, specify "-Fragment Status".

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-OptionSet
Passes a set of switches to a service to modify or refine the nature of the request. These are similar to swi
tches 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}

Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false

-Port
Specifies the port to use when the client connects to the WinRM service. When the transport is HTTP, the defaul
t port is 80. When the transport is HTTPS, the default port is 443. When you use HTTPS as the transport, the va
lue of the ComputerName parameter must match the server's certificate common name (CN). However, if the SkipCNC
heck parameter is specified as part of the SessionOption parameter, then the certificate common name of the ser
ver does not have to match the host name of the server. The SkipCNCheck parameter should be used only for trust
ed computers.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-References
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".

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-ResourceURI
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

Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false

-ReturnType
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 informatio
n about the resource URI and the selectors for the instance. If ObjectAndEPR is specified, both the object and
its associated endpoint references are returned.

Required? false
Position? named
Default value Object
Accept pipeline input? false
Accept wildcard characters? false

-SelectorSet
Specifies a set of value pairs that are used to select particular management resource instances. The SelectorSe
t 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"}

Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-SessionOption
Defines a set of extended options for the WS-Management session. Enter a SessionOption object that you create b
y using the New-WSManSessionOption cmdlet. For more information about the options that are available, see New-W
SManSessionOption.

Required? false
Position? named
Default value
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 retu
rned.

Required? false
Position? named
Default value
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 c
omputer. By default, SSL is not used.

WS-Management encrypts all the Windows PowerShell content that is transmitted over the network. The UseSSL par
ameter 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.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS
None
This command does not accept any input.


OUTPUTS
System.Xml.XmlElement
The Get-WSManInstance cmdlet generates an XMLElement object.


NOTES





-------------------------- EXAMPLE 1 --------------------------

C:\PS>get-wsmaninstance wmicimv2/win32_service -selectorset @{name="winrm"} -computername server01

xsi : http://www.w3.org/2001/XMLSchema-instance
p : http://schemas.microsoft.com/wbem/wsman/1/wmi/root/cimv2/Win32_Service
cim : http://schemas.dmtf.org/wbem/wscim/1/common
type : p:Win32_Service_Type
lang : en-US
AcceptPause : false
AcceptStop : true
Caption : Windows Remote Management (WS-Management)
CheckPoint : 0
CreationClassName : Win32_Service
Description : Windows Remote Management (WinRM) service implements the WS-Management protocol for remot
e
management. WS-Management is a standard web services protocol used for remote software an
d
hardware management. The WinRM service listens on the network for WS-Management requests
and processes them. The WinRM Service needs to be configured with a listener using the
winrm.cmd command line tool or through Group Policy in order for it to listen over the
network. The WinRM service provides access to WMI data and enables event collection. Even
t
collection and subscription to events require that the service is running. WinRM messages

use HTTP and HTTPS as transports. The WinRM service does not depend on IIS but is
preconfigured to share a port with IIS on the same machine. The WinRM service reserves t
he
/wsman URL prefix. To prevent conflicts with IIS, administrators should ensure that any
websites hosted on IIS do not use the /wsman URL prefix.
DesktopInteract : false
DisplayName : Windows Remote Management (WS-Management)
ErrorControl : Normal
ExitCode : 0
InstallDate : InstallDate
Name : winrm
PathName : C:\Windows\System32\svchost.exe -k NetworkService
ProcessId : 948
ServiceSpecificExitCode : 0
ServiceType : Share Process
Started : true
StartMode : Auto
StartName : NT AUTHORITY\NetworkService
State : Running
Status : OK
SystemCreationClassName : Win32_ComputerSystem
SystemName : SERVER01
TagId : 0
WaitHint : 0


Description
-----------
This command returns all of the information that Windows Management Instrumentation (WMI) exposes about the WinRM s
ervice on the remote server01 computer.





-------------------------- EXAMPLE 2 --------------------------

C:\PS>get-wsmaninstance wmicimv2/win32_service -selectorset @{name="spooler"} -fragment status -computername server
01

XmlFragment=OK


Description
-----------
This command returns only the status of the Spooler service on the remote server01 computer.





-------------------------- EXAMPLE 3 --------------------------

C:\PS>get-wsmaninstance -enumerate wmicimv2/win32_process

OSName : Microsoft Windows Vista Ultimate |C:\Windows|\Device\Harddisk0\Partition3
OtherOperationCount : 11441
OtherTransferCount : 428570
PageFaults : 27346
PageFileUsage : 16428
ParentProcessId : 604
PeakPageFileUsage : 17588
PeakVirtualSize : 93876224
PeakWorkingSetSize : 12472
Priority : 8
PrivatePageCount : 16822272
ProcessId : 1160
QuotaNonPagedPoolUsage : 14
QuotaPagedPoolUsage : 126
QuotaPeakNonPagedPoolUsage : 16
QuotaPeakPagedPoolUsage : 159
ReadOperationCount : 29568
ReadTransferCount : 1660581404
SessionId : 0
Status : Status
TerminationDate : TerminationDate
ThreadCount : 23
UserModeTime : 763156892
VirtualSize : 80846848
WindowsVersion : 6.0.6001
WorkingSetSize : 11624448
WriteOperationCount : 1913
WriteTransferCount : 6825768

xsi : http://www.w3.org/2001/XMLSchema-instance
p : http://schemas.microsoft.com/wbem/wsman/1/wmi/root/cimv2/Win32_Process
cim : http://schemas.dmtf.org/wbem/wscim/1/common
type : p:Win32_Process_Type
lang : en-US
Caption : svchost.exe
CommandLine : C:\Windows\System32\svchost.exe -k LocalSystemNetworkRestricted
CreationClassName : Win32_Process
CreationDate : CreationDate
CSCreationClassName : Win32_ComputerSystem
CSName : COMPUTER01
Description : svchost.exe
ExecutablePath : C:\Windows\System32\svchost.exe
ExecutionState : ExecutionState
Handle : 1192
HandleCount : 832

...


Description
-----------
This command returns all the instances of the WMI Win32_Process class on the local computer.





-------------------------- EXAMPLE 4 --------------------------

C:\PS>get-wsmaninstance -enumerate wmicimv2/win32_service -returntype epr

xsi : http://www.w3.org/2001/XMLSchema-instance
p : http://schemas.microsoft.com/wbem/wsman/1/wmi/root/cimv2/Win32_Service
cim : http://schemas.dmtf.org/wbem/wscim/1/common
type : p:Win32_Service_Type
lang : en-US
AcceptPause : false
AcceptStop : false
Caption : Visual Studio 2008 Remote Debugger
CheckPoint : 0
CreationClassName : Win32_Service
Description : Allows members of the Administrators group to remotely debug server applications using Vi
sual
Studio 2008. Use the Visual Studio 2008 Remote Debugging Configuration Wizard to enable
this
service.
DesktopInteract : false
DisplayName : Visual Studio 2008 Remote Debugger
ErrorControl : Ignore
ExitCode : 1077
InstallDate : InstallDate
Name : msvsmon90
PathName : "C:\Program Files\Microsoft Visual Studio 9.0\Common7\IDE\Remote Debugger\x86\msvsmon.exe
" /s
ervice msvsmon90
ProcessId : 0
ServiceSpecificExitCode : 0
ServiceType : Own Process
Started : false
StartMode : Disabled
StartName : LocalSystem
State : Stopped
Status : OK
SystemCreationClassName : Win32_ComputerSystem
SystemName : COMPUTER01
TagId : 0
WaitHint : 0

...


Description
-----------
This command returns endpoint references that correspond to all the services on the local computer.





-------------------------- EXAMPLE 5 --------------------------

C:\PS>Get-WSManInstance -Enumerate wmicimv2/* -filter "select * from win32_service where StartMode = 'Auto' and Sta
te = 'Stopped'" -computername server01

xsi : http://www.w3.org/2001/XMLSchema-instance
p : http://schemas.microsoft.com/wbem/wsman/1/wmi/root/cimv2/Win32_Service
cim : http://schemas.dmtf.org/wbem/wscim/1/common
type : p:Win32_Service_Type
lang : en-US
AcceptPause : false
AcceptStop : false
Caption : Windows Media Center Service Launcher
CheckPoint : 0
CreationClassName : Win32_Service
Description : Starts Windows Media Center Scheduler and Windows Media Center Receiver services
at startup if TV is enabled within Windows Media Center.
DesktopInteract : false
DisplayName : Windows Media Center Service Launcher
ErrorControl : Ignore
ExitCode : 0
InstallDate : InstallDate
Name : ehstart
PathName : C:\Windows\system32\svchost.exe -k LocalServiceNoNetwork
ProcessId : 0
ServiceSpecificExitCode : 0
ServiceType : Share Process
Started : false
StartMode : Auto
StartName : NT AUTHORITY\LocalService
State : Stopped
Status : OK
SystemCreationClassName : Win32_ComputerSystem
SystemName : Server01
TagId : 0
WaitHint : 0

...


Description
-----------
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.





-------------------------- EXAMPLE 6 --------------------------

C:\PS>get-wsmaninstance winrm/config/listener -selectorset @{Address="*";Transport="http"}

cfg : http://schemas.microsoft.com/wbem/wsman/1/config/listener
xsi : http://www.w3.org/2001/XMLSchema-instance
lang : en-US
Address : *
Transport : HTTP
Port : 80
Hostname :
Enabled : true
URLPrefix : wsman
CertificateThumbprint :
ListeningOn : {100.0.0.1, 123.123.123.123, ::1, 2001:4898:0:fff:0:5efe:123.123.123.123...}


Description
-----------
This command lists the WS-Management listener configuration on the local computer for the listener that matches the
criteria in the selector set.





-------------------------- EXAMPLE 7 --------------------------

C:\PS>get-wsmaninstance winrm/config/listener -selectorset @{Address="*";Transport="http"} -computername server01

cfg : http://schemas.microsoft.com/wbem/wsman/1/config/listener
xsi : http://www.w3.org/2001/XMLSchema-instance
lang : en-US
Address : *
Transport : HTTP
Port : 80
Hostname :
Enabled : true
URLPrefix : wsman
CertificateThumbprint :
ListeningOn : {100.0.0.1, 123.123.123.124, ::1, 2001:4898:0:fff:0:5efe:123.123.123.124...}


Description
-----------
This command lists the WS-Management listener configuration on the remote server01 computer for the listener that m
atches the criteria in the selector set.





-------------------------- EXAMPLE 8 --------------------------

C:\PS>Get-WSManInstance -Enumerate -Dialect association -filter "{Object=win32_service?name=winrm}" -res wmicimv2/*

xsi : http://www.w3.org/2001/XMLSchema-instance
p : http://schemas.microsoft.com/wbem/wsman/1/wmi/root/cimv2/Win32_ComputerSystem
cim : http://schemas.dmtf.org/wbem/wscim/1/common
type : p:Win32_ComputerSystem_Type
lang : en-US
AdminPasswordStatus : 1
AutomaticManagedPagefile : true
AutomaticResetBootOption : true
AutomaticResetCapability : true
BootOptionOnLimit : BootOptionOnLimit
BootOptionOnWatchDog : BootOptionOnWatchDog
BootROMSupported : true
BootupState : Normal boot
Caption : SERVER01
ChassisBootupState : 3
CreationClassName : Win32_ComputerSystem
CurrentTimeZone : -480
DaylightInEffect : false
Description : AT/AT COMPATIBLE
DNSHostName : server01
Domain : site01.corp.fabrikam.com
DomainRole : 1
EnableDaylightSavingsTime : true
FrontPanelResetStatus : 2
InfraredSupported : false
InstallDate : InstallDate
KeyboardPasswordStatus : 2
LastLoadInfo : LastLoadInfo
Manufacturer : Dell Inc.
Model : OptiPlex 745
Name : SERVER01
NameFormat : NameFormat
NetworkServerModeEnabled : true
NumberOfLogicalProcessors : 2
NumberOfProcessors : 1
OEMStringArray : www.dell.com
PartOfDomain : true
PauseAfterReset : -1
PCSystemType : 5
PowerManagementSupported : PowerManagementSupported
PowerOnPasswordStatus : 1
PowerState : 0
PowerSupplyState : 3
PrimaryOwnerContact : PrimaryOwnerContact
PrimaryOwnerName : testuser01
ResetCapability : 1
ResetCount : -1
ResetLimit : -1
Roles : {LM_Workstation, LM_Server, SQLServer, NT}
Status : OK
SystemStartupDelay : SystemStartupDelay
SystemStartupSetting : SystemStartupSetting
SystemType : X86-based PC
ThermalState : 3
TotalPhysicalMemory : 3217760256
UserName : FABRIKAM\testuser01
WakeUpType : 6
Workgroup : Workgroup

xsi : http://www.w3.org/2001/XMLSchema-instance
p : http://schemas.microsoft.com/wbem/wsman/1/wmi/root/cimv2/Win32_Service
cim : http://schemas.dmtf.org/wbem/wscim/1/common
type : p:Win32_Service_Type
lang : en-US
AcceptPause : false
AcceptStop : false
Caption : Remote Procedure Call (RPC)
CheckPoint : 0
CreationClassName : Win32_Service
Description : Serves as the endpoint mapper and COM Service Control Manager. If this service is stopped

or disabled, programs using COM or Remote Procedure Call (RPC) services will not function

properly.
DesktopInteract : false
DisplayName : Remote Procedure Call (RPC)
ErrorControl : Normal
ExitCode : 0
InstallDate : InstallDate
Name : RpcSs
PathName : C:\Windows\system32\svchost.exe -k rpcss
ProcessId : 1100
ServiceSpecificExitCode : 0
ServiceType : Share Process
Started : true
StartMode : Auto
StartName : NT AUTHORITY\NetworkService
State : Running
Status : OK
SystemCreationClassName : Win32_ComputerSystem
SystemName : SERVER01
TagId : 0
WaitHint : 0

xsi : http://www.w3.org/2001/XMLSchema-instance
p : http://schemas.microsoft.com/wbem/wsman/1/wmi/root/cimv2/Win32_SystemDriver
cim : http://schemas.dmtf.org/wbem/wscim/1/common
type : p:Win32_SystemDriver_Type
lang : en-US
AcceptPause : false
AcceptStop : true
Caption : HTTP
CreationClassName : Win32_SystemDriver
Description : HTTP
DesktopInteract : false
DisplayName : HTTP
ErrorControl : Normal
ExitCode : 0
InstallDate : InstallDate
Name : HTTP
PathName : C:\Windows\system32\drivers\HTTP.sys
ServiceSpecificExitCode : 0
ServiceType : Kernel Driver
Started : true
StartMode : Manual
StartName :
State : Running
Status : OK
SystemCreationClassName : Win32_ComputerSystem
SystemName : SERVER01
TagId : 0


Description
-----------
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.





-------------------------- EXAMPLE 9 --------------------------

C:\PS>Get-WSManInstance -Enumerate -Dialect association -References -filter "{Object=win32_service?name=winrm}" -re
s wmicimv2/*


Description
-----------
This command gets association instances that are related to the specified instance (winrm). Because the Dialect par
ameter is set to "association" and the Reference parameter is used, this command returns association instances, n
ot associated instances.

Important: You must enclose the filter in quotation marks, as shown in the example.






RELATED LINKS
Online version: http://go.microsoft.com/fwlink/?LinkId=141444
Connect-WSMan
Disable-WSManCredSSP
Disconnect-WSMan
Enable-WSManCredSSP
Get-WSManCredSSP
Invoke-WSManAction
New-WSManInstance
New-WSManSessionOption
Remove-WSManInstance
Set-WSManInstance
Set-WSManQuickConfig
Test-WSMan