Invoke-SCXDiscovery

Article
10/16/2013

Applies To: System Center 2012 - Operations Manager, System Center 2012 R2 Operations Manager, System Center 2012 SP1 - Operations Manager

Invoke-SCXDiscovery

Invokes the discovery operation for the specified configuration of UNIX and Linux computers.

Syntax

Parameter Set: Empty
Invoke-SCXDiscovery [-SCSession <Connection[]> ] [ <CommonParameters>]

Parameter Set: FromAgentNames
Invoke-SCXDiscovery [-SCSession <Connection[]> ] [ <CommonParameters>]

Parameter Set: FromHostNameAndManagementServerParameterSetName
Invoke-SCXDiscovery [-Name] <String[]> -WsManCredential <PSCredential> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-SshCredential <PSCredential> ] [-SshPort <Int32> ] [ <CommonParameters>]

Parameter Set: FromHostNameAndResourcePoolParameterSetName
Invoke-SCXDiscovery [-Name] <String[]> -ResourcePool <ManagementServicePool> -WsManCredential <PSCredential> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-SshCredential <PSCredential> ] [-SshPort <Int32> ] [ <CommonParameters>]

Parameter Set: FromIPRangeAndManagementServerParameterSetName
Invoke-SCXDiscovery [-IPRange] <IPAddress[]> -WsManCredential <PSCredential> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-SshCredential <PSCredential> ] [-SshPort <Int32> ] [ <CommonParameters>]

Parameter Set: FromIPRangeAndResourcePoolParameterSetName
Invoke-SCXDiscovery [-IPRange] <IPAddress[]> -ResourcePool <ManagementServicePool> -WsManCredential <PSCredential> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-SshCredential <PSCredential> ] [-SshPort <Int32> ] [ <CommonParameters>]

Parameter Set: FromManagementServer
Invoke-SCXDiscovery [-SCSession <Connection[]> ] [ <CommonParameters>]

Detailed Description

The Invoke-SCXDiscovery cmdlet invokes the discovery operation for the specified configuration of UNIX and Linux computers.

The operation uses an SSH credential object for privileged SSH installation actions and an optional Windows PowerShell credential object for low-privileged WS-Management agent communication. If the agent has been manually installed on the targeted hosts, only the low-privileged WS-Management credential is required.

The output of this cmdlet is an array of DiscoveryResult objects representing the discovery result for each targeted computer for which discovery was attempted.

Parameters

-ComputerName<String[]>

Specifies the name of a computer to establish a connection with. The computer must be running the System Center Data Access Service. The default value is the computer for the current management group connection. Valid formats include a NetBIOS name, an IP address, or a fully qualified domain name (FQDN). To specify the local computer, type the computer name, "localhost", or a dot (.).

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	false

-Credential<PSCredential>

Specifies a user account under which the management group connection will run. 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 are prompted for a password. For more information, type Get-Help Get-Credential.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	false

-IPRange<IPAddress[]>

Specifies a range of IP Addresses that will be used for discovery. The IPRange must contain two IP Addresses (for example, 192.168.0.1,192.168.0.254). Either the IPRange or Name parameters must be specified.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Name<String[]>

Specifies a list of valid host names, FQDNs, or IP Addresses (separated by a comma) that will be used for discovery. Either the IPRange or Name parameters must be specified. This parameter is accepted from the pipeline.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	false

-ResourcePool<ManagementServicePool>

Specifies a resource pool of servers, one of which is assigned to be the current management server and the others serving as backup management servers. This parameter requires a resource pool object and returns only the managed computers in that resource pool.

For information about how to get a resource pool object, type Get-Help Get-SCOMResourcePool.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-SCSession<Connection[]>

Specifies a connection.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	false

-SshCredential<PSCredential>

Specifies a privileged SSH credential used to perform the agent installation actions. If this parameter is not specified, the discovery fails unless an agent has been manually installed on the targeted computer.

For information about how to get an SSH credential object, type Get-Help Get-SCXSSHCredential.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-SshPort<Int32>

Specifies the port to use for SSH communication with the host. If not specified, the default value of 22 is used.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WsManCredential<PSCredential>

Specifies a credential used for low-privileged agent communication through WS-Management.

Type a user name, such as "User01" or enter a PSCredential object, such as one that is returned by the Get-Credential cmdlet. When you type a user name, you are prompted for a password. For more information, type Get-Help Get-Credential.

Aliases	none
Required?	true
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.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

DiscoveryResult

This cmdlet returns an array of DiscoveryResult objects representing the discovery result for each targeted computer for which discovery was planned.

Examples

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

Description

-----------

This command discovers UNIX and Linux computers within a range of IP addresses.

C:\PS>$WSCredential = Get-Credential userBob
$SSHCredential=Get-SCXSSHCredential -UserName userBob -Key c:\keys\mykey.ppk -ElevationType sudo
$MyPool = Get-SCOMResourcePool "pool01"
Invoke-SCXDiscovery -IPRange 192.168.1.50,192.168.1.75  -ResourcePool $MyPool -WSManCredential $WSCredential -SSHCredential $SSHCredential

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

Description

-----------

This command discovers UNIX and Linux computers by name using a resource pool and specifying a non-standard SSH port.

C:\PS>$WSCredential = Get-Credential userBob
$SSHCredential=Get-SCXSSHCredential -UserName userBob -Key c:\keys\userBob.ppk -ElevationType sudo
$MyPool = Get-SCOMResourcePool -DisplayName:"pool01"
Invoke-SCXDiscovery -Name "nx1.contoso.com,nx2.contoso.com,nx3.contoso.com" -SSHPort 8022  -ResourcePool $MyPool -WSManCredential $WSCredential -SSHCredential $SSHCredential

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

Description

-----------

This command discovers UNIX and Linux computers by name where the management agent has already been installed.

C:\PS>$MyPool = Get-SCOMResourcePool "RP1"
Invoke-SCXDiscovery -Name "nx1.contoso.com,nx2.contoso.com,nx3.contoso.com" -ResourcePool $MyPool -WSManCredential userBob

Invoke-SCXDiscovery