GetWSManInstanceCommand Class

Definition

Namespace:

Microsoft.WSMan.Management

Assembly:

Microsoft.WSMan.Management.dll

Package:

Microsoft.WSMan.Management v7.4.0

Executes action on a target object specified by RESOURCE_URI, where parameters are specified by key value pairs. eg., Call StartService method on the spooler service Invoke-WSManAction -Action StartService -ResourceURI wmicimv2/Win32_Service -SelectorSet {Name=Spooler}

[System.Management.Automation.Cmdlet("Get", "WSManInstance", DefaultParameterSetName="GetInstance", HelpUri="https://go.microsoft.com/fwlink/?LinkId=2096627")]
[System.Management.Automation.OutputType(new System.Type[] { typeof(System.Xml.XmlElement) })]
public class GetWSManInstanceCommand : Microsoft.WSMan.Management.AuthenticatingWSManCommand, IDisposable

[<System.Management.Automation.Cmdlet("Get", "WSManInstance", DefaultParameterSetName="GetInstance", HelpUri="https://go.microsoft.com/fwlink/?LinkId=2096627")>]
[<System.Management.Automation.OutputType(new System.Type[] { typeof(System.Xml.XmlElement) })>]
type GetWSManInstanceCommand = class
    inherit AuthenticatingWSManCommand
    interface IDisposable

Public Class GetWSManInstanceCommand
Inherits AuthenticatingWSManCommand
Implements IDisposable

Inheritance

Object

InternalCommand

Cmdlet

PSCmdlet

AuthenticatingWSManCommand

GetWSManInstanceCommand

Attributes

CmdletAttribute OutputTypeAttribute

Implements

IDisposable

Constructors

GetWSManInstanceCommand()

Properties

ApplicationName	The following is the definition of the input parameter "ApplicationName". ApplicationName identifies the remote endpoint.
Associations	The following is the definition of the input parameter "Associations". Associations indicates retrieval of association instances as opposed to associated instances. This can only be used when specifying the Dialect as Association.
Authentication	The following is the definition of the input parameter "Authentication". This parameter takes a set of authentication methods the user can select from. The available method are an enum called Authentication in the System.Management.Automation.Runspaces namespace. The available options should be as follows: Default : Use the default authentication (ad defined by the underlying protocol) for establishing a remote connection. Negotiate Kerberos Basic: Use basic authentication for establishing a remote connection. -CredSSP: Use CredSSP authentication for establishing a remote connection which will enable the user to perform credential delegation. (i.e. second hop) (Inherited from AuthenticatingWSManCommand)
BasePropertiesOnly	The following is the definition of the input parameter "BasePropertiesOnly". Enumerate only those properties that are part of the base class specification in the Resource URI. When Shallow is specified then this flag has no effect.
CertificateThumbprint	Specifies the certificate thumbprint to be used to impersonate the user on the remote machine. (Inherited from AuthenticatingWSManCommand)
CommandOrigin	This property tells you if you were being invoked inside the runspace or if it was an external request. (Inherited from InternalCommand)
CommandRuntime	Holds the command runtime object for this command. This object controls what actually happens when a write is called. (Inherited from Cmdlet)
ComputerName	The following is the definition of the input parameter "ComputerName". Executes the management operation on the specified computer(s). The default is the local computer. Type the fully qualified domain name, NETBIOS name or IP address to indicate the remote host(s)
ConnectionURI	The following is the definition of the input parameter "ConnectionURI". Specifies the transport, server, port, and Prefix, needed to connect to the remote machine. The format of this string is: transport://server:port/Prefix.
Credential	The following is the definition of the input parameter "Credential". Specifies a user account that has permission to perform this action. The default is the current user. (Inherited from AuthenticatingWSManCommand)
CurrentPSTransaction	Gets an object that surfaces the current PowerShell transaction. When this object is disposed, PowerShell resets the active transaction. (Inherited from Cmdlet)
Dialect	The following is the definition of the input parameter "Dialect". Defines the dialect for the filter predicate.
Enumerate	The following is the definition of the input parameter "Enumerate". Switch indicates list all instances of a management resource. Equivalent to WSManagement Enumerate.
Events	Gets the event manager for the current runspace. (Inherited from PSCmdlet)
Filter	The following is the definition of the input parameter "Filter". Indicates the filter expression for the enumeration.
Fragment	The following is the definition of the input parameter "Fragment". Specifies a section inside the instance that is to be updated or retrieved for the given operation.
Host	Gets the host interaction APIs. (Inherited from PSCmdlet)
InvokeCommand	Provides access to utility routines for executing scripts and creating script blocks. (Inherited from PSCmdlet)
InvokeProvider	Gets the instance of the provider interface APIs for the current runspace. (Inherited from PSCmdlet)
JobManager	Manager for JobSourceAdapters registered. (Inherited from PSCmdlet)
JobRepository	Repository for jobs. (Inherited from PSCmdlet)
MyInvocation	Contains information about the identity of this cmdlet and how it was invoked. (Inherited from PSCmdlet)
OptionSet	The following is the definition of the input parameter "OptionSet". OptionSet is a hashtable and is used to pass a set of switches to the service to modify or refine the nature of the request.
PagingParameters	If the cmdlet declares paging support (via SupportsPaging), then PagingParameters property contains arguments of the paging parameters. Otherwise PagingParameters property is null. (Inherited from PSCmdlet)
ParameterSetName	The name of the parameter set in effect. (Inherited from PSCmdlet)
Port	The following is the definition of the input parameter "Port". Specifies the port to be used when connecting to the ws management service.
ResourceURI	The following is the definition of the input parameter "ResourceURI". URI of the resource class/instance representation.
ReturnType	The following is the definition of the input parameter "ReturnType". Indicates the type of data returned. Possible options are 'Object', 'EPR', and 'ObjectAndEPR'. Default is Object. If Object is specified or if this parameter is absent then only the objects are returned If EPR is specified then only the EPRs of the objects are returned. EPRs contain information about the Resource URI and selectors for the instance If ObjectAndEPR is specified, then both the object and the associated EPRs are returned.
SelectorSet	The following is the definition of the input parameter "SelectorSet". SelectorSet is a hash table which helps in identify an instance of the management resource if there are more than 1 instance of the resource class.
SessionOption	The following is the definition of the input parameter "SessionOption". Defines a set of extended options for the WSMan session. This can be created by using the cmdlet New-WSManSessionOption.
SessionState	Gets the instance of session state for the current runspace. (Inherited from PSCmdlet)
Shallow	The following is the definition of the input parameter "Shallow". Enumerate only instances of the base class specified in the resource URI. If this flag is not specified, instances of the base class specified in the URI and all its derived classes are returned.
Stopping	Is this command stopping? (Inherited from Cmdlet)
UseSSL	The following is the definition of the input parameter "UseSSL". Uses the Secure Sockets Layer (SSL) protocol to establish a connection to the remote computer. If SSL is not available on the port specified by the Port parameter, the command fails.

Methods

BeginProcessing()	When overridden in the derived class, performs initialization of command execution. Default implementation in the base class just returns. (Inherited from Cmdlet)
CurrentProviderLocation(String)	(Inherited from PSCmdlet)
Dispose()	Public dispose method.
Dispose(IWSManSession)	Public dispose method.
EndProcessing()	BeginProcessing method.
GetResolvedProviderPathFromPSPath(String, ProviderInfo)	(Inherited from PSCmdlet)
GetResourceString(String, String)	Gets the resource string corresponding to baseName and resourceId from the current assembly. You should override this if you require a different behavior. (Inherited from Cmdlet)
GetUnresolvedProviderPathFromPSPath(String)	(Inherited from PSCmdlet)
GetVariableValue(String, Object)	(Inherited from PSCmdlet)
GetVariableValue(String)	(Inherited from PSCmdlet)
Invoke()	Invoke this cmdlet object returning a collection of results. (Inherited from Cmdlet)
Invoke<T>()	Returns a strongly-typed enumerator for the results of this cmdlet. (Inherited from Cmdlet)
ProcessRecord()	ProcessRecord method.
ShouldContinue(String, String, Boolean, Boolean, Boolean)	Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll. (Inherited from Cmdlet)
ShouldContinue(String, String, Boolean, Boolean)	Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll. (Inherited from Cmdlet)
ShouldContinue(String, String)	Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant only offers Yes/No, not YesToAll/NoToAll. (Inherited from Cmdlet)
ShouldProcess(String, String, String, ShouldProcessReason)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify the complete text describing the operation, rather than just the name and action. (Inherited from Cmdlet)
ShouldProcess(String, String, String)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify the complete text describing the operation, rather than just the name and action. (Inherited from Cmdlet)
ShouldProcess(String, String)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify text for both the target resource and the action. (Inherited from Cmdlet)
ShouldProcess(String)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. (Inherited from Cmdlet)
StopProcessing()	When overridden in the derived class, interrupts currently running code within the command. It should interrupt BeginProcessing, ProcessRecord, and EndProcessing. Default implementation in the base class just returns. (Inherited from Cmdlet)
ThrowTerminatingError(ErrorRecord)	Terminate the command and report an error. (Inherited from Cmdlet)
TransactionAvailable()	Returns true if a transaction is available and active. (Inherited from Cmdlet)
WriteCommandDetail(String)	Write text into pipeline execution log. (Inherited from Cmdlet)
WriteDebug(String)	Display debug information. (Inherited from Cmdlet)
WriteError(ErrorRecord)	Internal variant: Writes the specified error to the error pipe. (Inherited from Cmdlet)
WriteInformation(InformationRecord)	Route information to the user or host. (Inherited from Cmdlet)
WriteInformation(Object, String[])	Route information to the user or host. (Inherited from Cmdlet)
WriteObject(Object, Boolean)	Writes one or more objects to the output pipe. If the object is a collection and the enumerateCollection flag is true, the objects in the collection will be written individually. (Inherited from Cmdlet)
WriteObject(Object)	Writes the object to the output pipe. (Inherited from Cmdlet)
WriteProgress(ProgressRecord)	Display progress information. (Inherited from Cmdlet)
WriteVerbose(String)	Display verbose information. (Inherited from Cmdlet)
WriteWarning(String)	Display warning information. (Inherited from Cmdlet)