Microsoft OMS Agent Management (Windows)

Overview

A PowerShell module to aide with deployment and management of OMS agents on remote computers.

Commands

• Add-omsAgentWorkSpace
• Get-omsAgent
• Get-omsAgentWorkSpace
• Get-omsAgentProxy
• Install-omsAgent
• Remove-omsAgentWorkSpace
• Uninstall-omsAgent
• Update-omsAgentWorkSpace
• Remove-omsAgentProxy
• Add-omsAgentProxy
• Install-OmsDependencyAgent
• Uninstall-omsDependencyAgent
• Get-omsDependencyAgent

Examples

• Add-omsAgentWorkSpace

Add-omsAgentWorkSpace -computerName 'computer1', 'computer2' -workSpaceId '<workSpace>' -workSpaceKey '<workSpaceKey>'

$workSpace = Get-Credential
Add-omsAgentWorkSpace -computerName 'computer1', 'computer2' -workSpace $workSpace

• Add-omsAgentProxy

Add-omsAgentWorkSpace -computerName 'computer1', 'computer2' -workSpaceId '<workSpace>' -workSpaceKey '<workSpaceKey>'

$proxyCredential = Get-Credential
Add-omsAgentProxy -computerName 'computer1', 'computer2' -proxyURL 'proxy.local:443' -proxyCredential $proxyCredential

• Get-omsAgent

Get-omsAgent -computerName 'computer1', 'computer2'

• Get-omsAgentWorkSpace

Get-omsAgentWorkSpace -computerName 'computer1', 'computer2'

Get-omsAgentWorkSpace -computerName 'computer1', 'computer2' -workSpaceId '<workSpaceId>'

• Get-omsAgentProxy

Get-omsAgentProxy -computerName 'computer1', 'computer2'

• Install-omsAgent

$workSpace = Get-Credential
Install-OmsAgent -computerName 'computerOne' -workspace $workSpace -verbose

Install-OmsAgent -computerName <computerName> -workspaceID '<workSpaceID>' -workspaceKey '<workSpaceKey>' -Verbose

Install-OmsAgent -sourcePath 'c:\MMASetup-AMD64.exe' -workspaceID '<workSpaceID>' -workspaceKey '<workSpaceKey>' -Verbose

• Remove-omsAgentProxy

Remove-omsAgentProxy -computerName 'computer1', 'computer2'

• Remove-omsAgentWorkSpace

Remove-omsAgentWorkSpace -computerName 'computer1', 'computer2' -workspaceid '<workspaceid>'

• Uninstall-omsAgent

Uninstall-OmsAgent -computerName 'computer1', 'computer2' -Verbose

• Update-omsAgentWorkSpace

Update-omsAgwentWorkSpacekey -computerName 'computer1', 'computer2' -workspaceid '<workSpaceId>' -workspacekey '<workSpaceKey>'

$workSpace = Get-Credential
Update-omsAgwentWorkSpacekey -computerName 'computer1', 'computer2' -workSpace $workSpace

• Install-OmsDependencyAgent

Install-OmsDependencyAgent -computerName 'computer1', 'computer2'

Get-OmsAgent -computerName 'computer1', 'computer2' | Install-OmsDependencyAgent

• Get-omsDependencyAgent

Get-omsDependencyAgent -computerName 'computer1', 'computer2'

• Uninstall-omsDependencyAgent

Uninstall-omsDependencyAgent -computerName 'computer1', 'computer2' -Verbose

Get-OmsAgent -computerName 'computer1', 'computer2' | Uninstall-OmsDependencyAgent

Installation

The module is published to the PowerShell Gallery (https://www.powershellgallery.com/packages/omsAgent).

Install-Module -Name omsAgent

Versions

1.3

• Release adding the the following support:
  • Install-OmsDependencyAgent, Uninstall-omsDependencyAgent, Get-omsDependencyAgent

1.2

• Release adding the the following support:
  • Added Get-omsAgentProxy, Add-omsAgentProxy, Remove-omsAgentProxy

1.1

• Release adding the the following support:
  • Added Basic Tests.
  • Added support for using the WorkSpace ID and WorkSpace Key in the form of a PS Credential.

1.0

• Initial release with the following support:
  • Install\Un-Install Support.
  • Get support for workspaces\install status.
  • Add\Remove\Update agents on remote computers.

Limitations

• No 32 Bit agent support.

Contributors

• Ben Taylor