GetCimAssociatedInstanceCommand Class

The cmdlet retrieves instances connected to the given instance, which is called the source instance, via a given association. In an association each instance has a named role, and the same instance can participate in an association in different roles. Hence, the cmdlet takes SourceRole and AssociatorRole parameters, in addition to the Association parameter.

Namespace:   Microsoft.Management.Infrastructure.CimCmdlets
Assembly:  Microsoft.Management.Infrastructure.CimCmdlets (in Microsoft.Management.Infrastructure.CimCmdlets.dll)

Inheritance Hierarchy

System.Object
  System.Management.Automation.Internal.InternalCommand
    System.Management.Automation.Cmdlet
      Microsoft.Management.Infrastructure.CimCmdlets.CimBaseCommand
        Microsoft.Management.Infrastructure.CimCmdlets.GetCimAssociatedInstanceCommand

Syntax

[CmdletAttribute("Get", "CimAssociatedInstance", DefaultParameterSetName = "ComputerSet", 
    HelpUri = "https://go.microsoft.com/fwlink/?LinkId=227958")]
[OutputTypeAttribute(new Type[] { ... })]
public class GetCimAssociatedInstanceCommand : CimBaseCommand

[CmdletAttribute("Get", "CimAssociatedInstance", DefaultParameterSetName = "ComputerSet", 
    HelpUri = "https://go.microsoft.com/fwlink/?LinkId=227958")]
[OutputTypeAttribute(new array<Type^>^ { ... })]
public ref class GetCimAssociatedInstanceCommand : CimBaseCommand

[<CmdletAttribute("Get", "CimAssociatedInstance", DefaultParameterSetName = "ComputerSet",
    HelpUri = "https://go.microsoft.com/fwlink/?LinkId=227958")>]
[<OutputTypeAttribute([| ... |])>]
type GetCimAssociatedInstanceCommand = 
    class
        inherit CimBaseCommand
    end

<CmdletAttribute("Get", "CimAssociatedInstance", DefaultParameterSetName := "ComputerSet",
    HelpUri := "https://go.microsoft.com/fwlink/?LinkId=227958")>
<OutputTypeAttribute(New Type() { ... })>
Public Class GetCimAssociatedInstanceCommand
    Inherits CimBaseCommand

Constructors

	Name	Description
	GetCimAssociatedInstanceCommand()	Constructor for a class that retrieves instances connected to the given instance, which is called the source instance, via a given association.

Properties

	Name	Description
	Association	Gets and sets the Association parameter, which specifies the class name of the association to be traversed from the SourceRole to AssociatorRole.
	CimSession	Gets and sets the CimSession parameter, which identifies the session to use for retrieving the instances.
	CommandOrigin	(Inherited from InternalCommand.)
	CommandRuntime	(Inherited from Cmdlet.)
	ComputerName	Gets and sets the ComputerName parameter, which specifies the name of the computer where the source instance is stored and where the association traversal should begin. This is an optional parameter and if it is not provided, the default value will be "localhost".
	CurrentPSTransaction	(Inherited from Cmdlet.)
	InputObject	Gets and sets the InputObject parameter, which provides the instance from which the association traversal is to begin.
	KeyOnly	Gets and sets the KeyOnly parameter, which indicates that only key properties of the retrieved instances will be returned to the client.
	Namespace	Gets and sets the Namespace parameter, which identifies the namespace in which the source class is registered.
	OperationTimeoutSec	Gets and sets the OperationTimeoutSec parameter, which specifies the operation timeout in seconds. This setting overrides the value in the CIM session.
	ResourceUri	Gets and sets the ResourceUri parameter, which defines the resource URI for which the instances are retrieved.
	ResultClassName	Gets and sets the ResultClassName parameter, which specifies the class name of the associated instances. A CIM instance can be associated with one or more CIM instances. All associated CIM instances are returned if you do not specify the result class name. By default, the value of this parameter is null, which means all associated CIM instances will be returned.
	Stopping	(Inherited from Cmdlet.)

Methods

	Name	Description
	BeginProcessing()	BeginProcessing method.(Overrides Cmdlet.BeginProcessing().)
	Dispose()	Releases resources.(Inherited from CimBaseCommand.)
	Dispose(Boolean)	Releases resources.(Inherited from CimBaseCommand.)
	DisposeInternal()	Disposes of all managed and unmanaged resources.(Inherited from CimBaseCommand.)
	EndProcessing()	EndProcessing method.(Overrides Cmdlet.EndProcessing().)
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetResourceString(String, String)	(Inherited from Cmdlet.)
	GetType()	(Inherited from Object.)
	Invoke()	(Inherited from Cmdlet.)
	MemberwiseClone()	(Inherited from Object.)
	ProcessRecord()	ProcessRecord method.(Overrides Cmdlet.ProcessRecord().)
	ShouldContinue(String, String)	(Inherited from Cmdlet.)
	ShouldContinue(String, String, Boolean, Boolean, Boolean)	(Inherited from Cmdlet.)
	ShouldContinue(String, String, Boolean, Boolean)	(Inherited from Cmdlet.)
	ShouldProcess(String)	(Inherited from Cmdlet.)
	ShouldProcess(String, String)	(Inherited from Cmdlet.)
	ShouldProcess(String, String, String)	(Inherited from Cmdlet.)
	ShouldProcess(String, String, String, ShouldProcessReason)	(Inherited from Cmdlet.)
	StopProcessing()	StopProcessing method.(Inherited from CimBaseCommand.)
	ThrowTerminatingError(ErrorRecord)	(Inherited from Cmdlet.)
	ToString()	(Inherited from Object.)
	TransactionAvailable()	(Inherited from Cmdlet.)
	WriteCommandDetail(String)	(Inherited from Cmdlet.)
	WriteDebug(String)	(Inherited from Cmdlet.)
	WriteError(ErrorRecord)	(Inherited from Cmdlet.)
	WriteInformation(InformationRecord)	(Inherited from Cmdlet.)
	WriteInformation(Object, String[])	(Inherited from Cmdlet.)
	WriteObject(Object)	(Inherited from Cmdlet.)
	WriteObject(Object, Boolean)	(Inherited from Cmdlet.)
	WriteProgress(ProgressRecord)	(Inherited from Cmdlet.)
	WriteVerbose(String)	(Inherited from Cmdlet.)
	WriteWarning(String)	(Inherited from Cmdlet.)

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Microsoft.Management.Infrastructure.CimCmdlets Namespace

Return to top