Get-WSManInstance

Display management information for a resource instance specified by a Resource URI.

Syntax
      Get-WSManInstance -SelectorSet hashtable [-ApplicationName string]
         [-ComputerName string] [-Credential PSCredential] [-Fragment string]
            [-Port int] [-UseSSL] [-ResourceURI] Uri
               [-Authentication Authentication] [-Dialect Uri] [-OptionSet hashtable]
                  [-SessionOption hashtable] [CommonParameters]
    
      Get-WSManInstance [-ApplicationName string] [-BasePropertiesOnly]
         [-ComputerName string] [-Credential PSCredential]  [-Enumerate] [-filter string]
            [-Port int] [-References] [-ReturnType string]
               [-Shallow] [-UseSSL] [-ResourceURI] Uri
                  [-Authentication Authentication] [-Dialect Uri] [-OptionSet hashtable]
                     [-SessionOption hashtable] [CommonParameters]
    
      Get-WSManInstance -ConnectionURI Uri -SelectorSet hashtable [-Fragment string] [-ResourceURI] Uri
         [-Authentication Authentication] [-Dialect Uri] [-OptionSet hashtable]
            [-SessionOption hashtable] [CommonParameters]
    
      Get-WSManInstance -ConnectionURI Uri [-BasePropertiesOnly]
         [-Enumerate] [-filter string] [-References] [-ReturnType string]
            [-Shallow] [-ResourceURI] Uri
               [-Authentication Authentication] [-Dialect Uri] [-OptionSet hashtable]
                  [-SessionOption hashtable] [CommonParameters]

Key
   -ApplicationName string
      The application name in the connection. The default Application Name is "WSMAN"
      The complete identifier for the remote endpoint is in the following format:
           transport://server:port/ApplicationName
      For example:
           http://server64:8080/WSMAN

      IIS will forward 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 PowerShell.
      In this case, IIS hosts Web Services for Management (WS-Management) for efficiency.

   -Authentication Authentication
      The authentication mechanism to be used at the server. Possible values are:
        
      - Basic      Send username and password in clear text.
      - Default    Use the authentication method implemented by WS-Management protocol. This is the default.
      - Digest     Challenge-response scheme using a server-specified data string for the challenge.
      - Kerberos   Authenticate by using Kerberos certificates.
      - Negotiate  Challenge-response that negotiates an authentication scheme.
                    e.g. Kerberos protocol or NTLM.
      - CredSSP    Use Credential Security Service Provider (CredSSP) authentication, delegate
                   credentials to a remote computer. This increases the security risk, if the remote 
                   computer is compromised, the credentials could be used to control the network session.

   -BasePropertiesOnly
      Enumerate only the properties that are part of the base class specified by -ResourceURI.
      This has no effect if -Shallow is specified.

   -ComputerName string
      The computer against which you want to run the management operation.
      A fully qualified domain name, NetBIOS name, or an IP address.
      Use the local computer name, localhost, or a dot (.) to specify the local computer.
      The local computer is the default. When the remote computer is in a different domain,
      use a fully qualified domain name. You can pipe a value for ComputerName.
        
   -ConnectionURI Uri
      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.
        
   -Credential PSCredential
      A user account that has permission to perform this action. default=current user.
      e.g. "User64", "Domain64\User64", or "User@Domain.com". Or a PSCredential object, such as 
      returned by the Get-Credential cmdlet.
      When you type a user name, you will be prompted for a password.

   -Dialect Uri
      The dialect to use in the filter predicate.
      Any dialect that is supported by the remote service.
      The following 3 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

   -Enumerate
      Return all instances of a management resource.

   -filter string
      The filter expression for the enumeration.
      If you use this parameter, you must also specify -Dialect. 
        
      The valid filter values depend on the dialect that is specified.
      For example, if -Dialect is WQL, the Filter parameter must contain
      a string, and the string must contain a valid WQL query such as:
        
             "Select * from Win32_Service where State != Running"
        
      If -Dialect is set to Association, the Filter parameter must contain
      a string, and the string must contain a valid filter, such as:
        
      -filter:Object=EPR[;AssociationClassName=AssocClassName][;ResultClassName=ClassName][;Role=RefPropertyName][;ResultRole=RefPropertyName]}

   -Fragment string
      A section inside the instance that is to be updated or retrieved.
      For example, to get the status of a spooler service, specify "-Fragment Status".

   -OptionSet hashtable
      Pass a set of switches to the service to modify or refine the nature of the request.
      These are similar to switches used in command-line shells in that 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}

   -Port int
      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.

   -References 
      Indicates that association instances (not associated instances) should be retrieved.
      Use this only when -Dialect is set to a value of "Association".
        
   -ResourceURI Uri
      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
        
   -ReturnType string
      The type of data to be returned. 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.
        
   -SelectorSet hashtable
      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"}

   -SessionOption hashtable
      Define a set of extended options for the WS-Management session.
      Enter a SessionOption object that you create by using New-WSManSessionOption.

   -Shallow 
      Cause 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 will be returned.

   -UseSSL
      Use the Secure Sockets Layer (SSL) protocol to establish a connection to the remote computer.
      By default, SSL is not used. 
        
      WS-Management encrypts all PowerShell content that is transmitted over the network.
      The UseSSL parameter lets you specify the additional protection of HTTPS instead of HTTP.
      This will fail if SSL is not available on the port that is used for the connection.

   CommonParameters:
       -Verbose, -Debug, -ErrorAction, -ErrorVariable, -WarningAction, -WarningVariable,
       -OutBuffer -OutVariable.

Get-WSManInstance 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.

Examples

Return all the information that WMI exposes about the spooler service on the remote server64 computer:

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

Return only the spooler service STATUS on the remote server64 computer:

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

Return all the instances of the WMI Win32_Process class on the local computer:

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

Return all the services on server64 that are stopped and have a startup type of Automatic:

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

“I can teach anybody how to get what they want out of life. The problem is that I can't find anybody who can tell me what they want” ~ Mark Twain

Related:

Set-WSManInstance - Modify the management information related to a resource


© Copyright SS64.com 1999-2014
Some rights reserved