Export (0) Print
Expand All

Install-SCXAgent

Updated: November 1, 2013

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

Install-SCXAgent

Installs the Operations Manager agent for discovered UNIX and Linux computers, signs the certificate for WS-Management communication, and registers the agent with Operations Manager for management.

Syntax

Parameter Set: Default
Install-SCXAgent [-DiscoveryResult] <DiscoveryResult[]> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: Empty
Install-SCXAgent [-SCSession <Connection[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: FromAgentNames
Install-SCXAgent [-SCSession <Connection[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: FromManagementServer
Install-SCXAgent [-SCSession <Connection[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Install-SCXAgent cmdlet installs the Operations Manager agent for discovered UNIX and Linux computers, signs the certificate for WS-Management communication, and registers the agent with Operations Manager for management. UNIX and Linux computers should be discovered with the Invoke-SCXDiscovery cmdlet. The output object of the Invoke-SCXDiscovery cmdlet is provided as the DiscoveryResult input for the Install-SCXAgent cmdlet.

For information about discovering UNIX or Linux computers, type Get-Help Invoke-SCXDiscovery.

This cmdlet returns an array of managed UNIX or Linux computer objects that represent the targeted systems that were successfully installed.

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

-DiscoveryResult<DiscoveryResult[]>

Specifies the DiscoveryResult object to process for management agent installation as returned by the Invoke-SCXDiscovery cmdlet.

For more information about discovering targeted systems, type Get-Help Invoke-SCXDiscovery.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

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

-Confirm

Prompts you for confirmation before executing the command.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Describes what would happen if you executed the command without actually executing the command.


Required?

false

Position?

named

Default Value

false

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.

  • Microsoft.Unix.Computer[]


    This cmdlet returns an array of managed UNIX and Linux computers that were successfully installed.


Examples

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

Description

-----------

This command invokes a discovery of UNIX and Linux computers within a range of IP Addresses and install the management agent.


C:\PS>$WSCredential = Get-Credential userBob$SSHCredential=Get-SCXSSHCredential -UserName userBob -Key c:\keys\foo.ppk -ElevationType sudo$MyPool = Get-SCOMResourcePool -DisplayName:"pool01"Invoke-SCXDiscovery -IPRange 192.168.1.50,192.168.1.75  -ResourcePool:$MyPool -WSManCredential $WSCredential -SSHCredential $SSHCredential | Install-SCXAgent
 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft