PowerCLI Reference

Get-OMUser

Synopsis

This cmdlet retrieves local user accounts from the specified vRealize Operations Manager server.

Syntax

Get-OMUser [-Enabled <Boolean>] [[-Name] <String[]>] [-Email <String[]>] [-Server <OMServer[]>] [<CommonParameters>]

Get-OMUser -Id <String[]> [-Server <OMServer[]>] [<CommonParameters>]

Related Commands

Online version

Detailed Description

This cmdlet retrieves local user accounts from the specified vRealize Operations Manager server.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
NameString[]Filters the local user accounts by name.falsefalse
EmailString[]Filters the local user accounts by email address.falsefalse
EnabledBooleanFilters the local user accounts that are enabled to use vRealize Operations Manager features.falsefalse
IdString[]Filters the local user accounts by ID.truefalse
ServerOMServer[]Specifies the vRealize Operations Manager server from which you want to retrieve alerts. The value can be the connection object returned by the Connect-OMServer cmdlet or the object's name, which can be the IP or DNS address of the server machine.falsefalse

Return Type

Zero or more OMUser objects

Notes

Examples

-------------- Example 1 --------------

Get-OMUser -Email 'user_email'

Retrieves a specific user by the user`s email address.

Note: The "admin" user is not returned.

-------------- Example 2 --------------

Get-OMUser -Name 'administrator*'

Retrieves all users with names starting with the administrator string.

Note: The "admin" user is not returned.


Copyright © VMware, Inc. All rights reserved.