Get-RubrikUser

SYNOPSIS

Gets settings of a Rubrik user

SYNTAX

Query (Default)

Get-RubrikUser [[-Username] <String>] [-AuthDomainId <String>] [-PrincipalType <String>] [-DetailedObject]
 [-Server <String>] [-api <String>] [<CommonParameters>]

ID

Get-RubrikUser [-PrincipalType <String>] [-Id] <String> [-DetailedObject] [-Server <String>] [-api <String>]
 [<CommonParameters>]

DESCRIPTION

The Get-RubrikUser cmdlet is used to query the Rubrik cluster to retrieve a list of settings around a Rubrik user account.

EXAMPLES

EXAMPLE 1

Get-RubrikUser

This will return settings of all of the user accounts (local and LDAP) configured within the Rubrik cluster.

EXAMPLE 2

Get-RubrikUser -authDomainId 'local'

This will return settings of all of the user accounts belonging to the local authoriation domain.

EXAMPLE 3

Get-RubrikUser -username 'john.doe'

This will return settings for the user account with the username of john.doe configured within the Rubrik cluster.

EXAMPLE 4

Get-RubrikUser -username 'john.doe' -DetailedObject

This will return full details of the settings for the user account with the username of john.doe configured within the Rubrik cluster.

EXAMPLE 5

Get-RubrikUser -authDomainId '1111-222-333'

This will return settings of all of the user accounts belonging to the specified authoriation domain.

EXAMPLE 6

Get-RubrikUser -id '1111-22222-33333-4444-5555'

This will return detailed information about the user with the specified ID.

PARAMETERS

-Username

Username to filter on

Type: String
Parameter Sets: Query
Aliases: name

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AuthDomainId

AuthDomainId to filter on

Type: String
Parameter Sets: Query
Aliases: auth_domain_id

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PrincipalType

PrincipalType - For 5.3 and above

Type: String
Parameter Sets: (All)
Aliases: principal_type

Required: False
Position: Named
Default value: User
Accept pipeline input: False
Accept wildcard characters: False

-Id

User ID

Type: String
Parameter Sets: ID
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-DetailedObject

DetailedObject will retrieved the detailed User object, the default behavior of the API is to only retrieve a subset of the full User object unless we query directly by ID. Using this parameter does affect performance as more data will be retrieved and more API-queries will be performed.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Server

Rubrik server IP or FQDN

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: $global:RubrikConnection.server
Accept pipeline input: False
Accept wildcard characters: False

-api

API version

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: $global:RubrikConnection.api
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

Written by Mike Preston for community usage Twitter: @mwpreston GitHub: mwpreston

RELATED LINKS

https://rubrik.gitbook.io/rubrik-sdk-for-powershell/command-documentation/reference/get-rubrikuser