Rubrik SDK for PowerShell
master
develmaster
master
develmaster
  • README
  • User Documentation
    • Contribution
    • FAQ
    • Getting Started
    • Installation
    • Licensing
    • Project Architecture
    • Requirements
    • Support
  • Command Documentation
    • Workflow
      • Flow Audit
    • Reference
      • Connect-Rubrik
      • Disconnect-Rubrik
      • Export-RubrikDatabase
      • Export-RubrikReport
      • Export-RubrikVApp
      • Export-RubrikVCDTemplate
      • Export-RubrikVM
      • Find-RubrikFile
      • Get-RubrikAPIToken
      • Get-RubrikAPIVersion
      • Get-RubrikArchive
      • Get-RubrikAvailabilityGroup
      • Get-RubrikBackupServiceDeployment
      • Get-RubrikBlackout
      • Get-RubrikBootStrap
      • Get-RubrikClusterInfo
      • Get-RubrikClusterNetworkInterface
      • Get-RubrikClusterStorage
      • Get-RubrikClusterUpgradeHistory
      • Get-RubrikDatabase
      • Get-RubrikDatabaseDownloadLink
      • Get-RubrikDatabaseFiles
      • Get-RubrikDatabaseMount
      • Get-RubrikDatabaseRecoverableRange
      • Get-RubrikDatabaseRecoveryPoint
      • Get-RubrikDebugInfo
      • Get-RubrikDNSSetting
      • Get-RubrikDownloadLink
      • Get-RubrikEmailSetting
      • Get-RubrikEvent
      • Get-RubrikEventSeries
      • Get-RubrikFileset
      • Get-RubrikFilesetTemplate
      • Get-RubrikGuestOSCredential
      • Get-RubrikHost
      • Get-RubrikHostVolume
      • Get-RubrikHvmFormatAutoUpgrade
      • Get-RubrikHvmFormatClusterStorage
      • Get-RubrikHvmFormatReport
      • Get-RubrikHvmFormatUpgradeReport
      • Get-RubrikHyperVHost
      • Get-RubrikHyperVMount
      • Get-RubrikHyperVVM
      • Get-RubrikIPMI
      • Get-RubrikLDAP
      • Get-RubrikLoginBanner
      • Get-RubrikLogShipping
      • Get-RubrikManagedVolume
      • Get-RubrikManagedVolumeExport
      • Get-RubrikModuleDefaultParameter
      • Get-RubrikModuleOption
      • Get-RubrikMount
      • Get-RubrikNASShare
      • Get-RubrikNetworkThrottle
      • Get-RubrikNfsArchive
      • Get-RubrikNode
      • Get-RubrikNotificationSetting
      • Get-RubrikNTPServer
      • Get-RubrikNutanixCluster
      • Get-RubrikNutanixVM
      • Get-RubrikObject
      • Get-RubrikObjectStoreArchive
      • Get-RubrikOracleDB
      • Get-RubrikOrganization
      • Get-RubrikOrgAuthorization
      • Get-RubrikProxySetting
      • Get-RubrikQstarArchive
      • Get-RubrikReplicationSource
      • Get-RubrikReplicationTarget
      • Get-RubrikReport
      • Get-RubrikReportData
      • Get-RubrikRequest
      • Get-RubrikScvmm
      • Get-RubrikSecurityClassification
      • Get-RubrikSetting
      • Get-RubrikSLA
      • Get-RubrikSmbDomain
      • Get-RubrikSmbSecurity
      • Get-RubrikSnapshot
      • Get-RubrikSNMPSetting
      • Get-RubrikSoftwareVersion
      • Get-RubrikSQLInstance
      • Get-RubrikSupportTunnel
      • Get-RubrikSyslogServer
      • Get-RubrikUnmanagedObject
      • Get-RubrikUser
      • Get-RubrikUserRole
      • Get-RubrikVApp
      • Get-RubrikVAppExportOption
      • Get-RubrikVAppRecoverOption
      • Get-RubrikVAppSnapshot
      • Get-RubrikVCD
      • Get-RubrikVCDTemplateExportOption
      • Get-RubrikVCenter
      • Get-RubrikVersion
      • Get-RubrikVgfAutoUpgrade
      • Get-RubrikVgfClusterStorage
      • Get-RubrikVgfReport
      • Get-RubrikVgfUpgradeReport
      • Get-RubrikVM
      • Get-RubrikVMSnapshot
      • Get-RubrikVMwareCluster
      • Get-RubrikVMwareDatacenter
      • Get-RubrikVMwareDatastore
      • Get-RubrikVMwareHost
      • Get-RubrikVolumeGroup
      • Get-RubrikVolumeGroupMount
      • Invoke-RubrikGraphQLCall
      • Invoke-RubrikHvmFormatUpgrade
      • Invoke-RubrikRESTCall
      • Invoke-RubrikVgfUpgrade
      • Move-RubrikMountVMDK
      • New-RubrikAPIToken
      • New-RubrikBootStrap
      • New-RubrikDatabaseMount
      • New-RubrikFileset
      • New-RubrikFilesetTemplate
      • New-RubrikHost
      • New-RubrikHyperVVMMount
      • New-RubrikLDAP
      • New-RubrikLogBackup
      • New-RubrikLogShipping
      • New-RubrikManagedVolume
      • New-RubrikManagedVolumeExport
      • New-RubrikMount
      • New-RubrikNASShare
      • New-RubrikOrganization
      • New-RubrikReport
      • New-RubrikSLA
      • New-RubrikSnapshot
      • New-RubrikUser
      • New-RubrikVCenter
      • New-RubrikVMDKMount
      • New-RubrikVolumeGroupMount
      • Protect-RubrikDatabase
      • Protect-RubrikFileset
      • Protect-RubrikHyperVVM
      • Protect-RubrikNutanixVM
      • Protect-RubrikTag
      • Protect-RubrikVApp
      • Protect-RubrikVM
      • Protect-RubrikVolumeGroup
      • Register-RubrikBackupService
      • Remove-RubrikAPIToken
      • Remove-RubrikDatabaseMount
      • Remove-RubrikDatabaseSnapshots
      • Remove-RubrikFileset
      • Remove-RubrikFilesetSnapshot
      • Remove-RubrikFilesetTemplate
      • Remove-RubrikHost
      • Remove-RubrikHyperVMount
      • Remove-RubrikHyperVSnapshot
      • Remove-RubrikLogShipping
      • Remove-RubrikManagedVolume
      • Remove-RubrikManagedVolumeExport
      • Remove-RubrikManagedVolumeSnapshot
      • Remove-RubrikModuleDefaultParameter
      • Remove-RubrikMount
      • Remove-RubrikNASShare
      • Remove-RubrikNutanixVMSnapshot
      • Remove-RubrikOrganization
      • Remove-RubrikOrgAuthorization
      • Remove-RubrikProxySetting
      • Remove-RubrikReport
      • Remove-RubrikSLA
      • Remove-RubrikUnmanagedObject
      • Remove-RubrikUser
      • Remove-RubrikVCenter
      • Remove-RubrikVMSnapshot
      • Remove-RubrikVolumeGroupMount
      • Remove-RubrikVolumeGroupSnapshot
      • Reset-RubrikLogShipping
      • Restore-RubrikDatabase
      • Restore-RubrikVApp
      • Resume-RubrikSLA
      • Set-RubrikAvailabilityGroup
      • Set-RubrikBlackout
      • Set-RubrikDatabase
      • Set-RubrikHvmFormatAutoUpgrade
      • Set-RubrikHyperVVM
      • Set-RubrikLogShipping
      • Set-RubrikManagedVolume
      • Set-RubrikModuleDefaultParameter
      • Set-RubrikModuleOption
      • Set-RubrikMount
      • Set-RubrikNASShare
      • Set-RubrikNutanixVM
      • Set-RubrikOrgAuthorization
      • Set-RubrikProxySetting
      • Set-RubrikReport
      • Set-RubrikSetting
      • Set-RubrikSLA
      • Set-RubrikSQLInstance
      • Set-RubrikSupportTunnel
      • Set-RubrikUser
      • Set-RubrikUserRole
      • Set-RubrikVCD
      • Set-RubrikVCenter
      • Set-RubrikVgfAutoUpgrade
      • Set-RubrikVM
      • Set-RubrikVolumeFilterDriver
      • Start-RubrikDownload
      • Start-RubrikManagedVolumeSnapshot
      • Stop-RubrikManagedVolumeSnapshot
      • Suspend-RubrikSLA
      • Sync-RubrikAnnotation
      • Sync-RubrikTag
      • Test-RubrikSnapshotVerification
      • Update-RubrikHost
      • Update-RubrikNutanixCluster
      • Update-RubrikVCD
      • Update-RubrikVCenter
      • Update-RubrikVMwareVM
Powered by GitBook
On this page
  • SYNOPSIS
  • SYNTAX
  • ReadOnlyAdmin
  • EndUserRemove
  • EndUserAdd
  • NoAccess
  • Admin
  • DESCRIPTION
  • EXAMPLES
  • EXAMPLE 1
  • EXAMPLE 2
  • EXAMPLE 3
  • EXAMPLE 4
  • EXAMPLE 5
  • PARAMETERS
  • -Id
  • -Admin
  • -EndUser
  • -NoAccess
  • -ReadOnlyAdmin
  • -Add
  • -Remove
  • -EventObjects
  • -RestoreWithoutDownloadObjects
  • -RestoreWithOverwriteObjects
  • -OnDemandSnapshotObjects
  • -ReportObjects
  • -RestoreObjects
  • -InfrastructureObjects
  • -Server
  • -api
  • -WhatIf
  • -Confirm
  • CommonParameters
  • INPUTS
  • OUTPUTS
  • NOTES
  • RELATED LINKS

Was this helpful?

  1. Command Documentation
  2. Reference

Set-RubrikUserRole

SYNOPSIS

Updates an existing users role

SYNTAX

ReadOnlyAdmin

Set-RubrikUserRole -Id <String[]> [-ReadOnlyAdmin] [-Server <String>] [-api <String>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

EndUserRemove

Set-RubrikUserRole -Id <String[]> [-EndUser] [-Remove] [-EventObjects <String[]>]
 [-RestoreWithoutDownloadObjects <String[]>] [-RestoreWithOverwriteObjects <String[]>]
 [-OnDemandSnapshotObjects <String[]>] [-ReportObjects <String[]>] [-RestoreObjects <String[]>]
 [-InfrastructureObjects <String[]>] [-Server <String>] [-api <String>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

EndUserAdd

Set-RubrikUserRole -Id <String[]> [-EndUser] [-Add] [-EventObjects <String[]>]
 [-RestoreWithoutDownloadObjects <String[]>] [-RestoreWithOverwriteObjects <String[]>]
 [-OnDemandSnapshotObjects <String[]>] [-ReportObjects <String[]>] [-RestoreObjects <String[]>]
 [-InfrastructureObjects <String[]>] [-Server <String>] [-api <String>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

NoAccess

Set-RubrikUserRole -Id <String[]> [-NoAccess] [-Server <String>] [-api <String>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

Admin

Set-RubrikUserRole -Id <String[]> [-Admin] [-Server <String>] [-api <String>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

The Set-RubrikUserRole cmdlet is used modify a users role and authorizations to objects within the Rubrik cluster

EXAMPLES

EXAMPLE 1

Set-RubrikUserRole -id 'User:::1111-2222-3333' -Admin

This will set the specifed users role to admin

EXAMPLE 2

Set-RubrikUserRole -id 'User:::1111-2222-3333' -ReadOnlyAdmin

This will set the specifed users role to read only admin. Valid on Rubrik CDM 5.0 and later

EXAMPLE 3

Set-RubrikUserRole -id 'User:::1111-2222-3333' -EndUser -Add -RestoreObjects 'VirtualMachine:::1111-222'

This will set the specifed users role to end user, granting access to restore the specified virtual machine

EXAMPLE 4

Set-RubrikUserRole -id 'User:::1111-2222-3333' -EndUser -Remove -RestoreObjects 'VirtualMachine:::1111-222'

This will set the specifed users role to end user, removing access to restore the specified virtual machine

EXAMPLE 5

Set-RubrikUserRole -id 'User:::1111-2222-3333' -NoAccess

This will remove all permissions on the Rubrik cluster for the specified user.

PARAMETERS

-Id

User ID

Type: String[]
Parameter Sets: (All)
Aliases: principals

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

-Admin

Sets users role to Admin

Type: SwitchParameter
Parameter Sets: Admin
Aliases:

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

-EndUser

Sets users role to End User

Type: SwitchParameter
Parameter Sets: EndUserRemove, EndUserAdd
Aliases:

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

-NoAccess

Sets users role to No Access (Removes all access from user)

Type: SwitchParameter
Parameter Sets: NoAccess
Aliases:

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

-ReadOnlyAdmin

Sets users role to No Access (Removes all access from user)

Type: SwitchParameter
Parameter Sets: ReadOnlyAdmin
Aliases:

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

-Add

Specifies -Privileges should be added to the users authorizations

Type: SwitchParameter
Parameter Sets: EndUserAdd
Aliases:

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

-Remove

Specifies -Privileges should be removed from the users authorizations

Type: SwitchParameter
Parameter Sets: EndUserRemove
Aliases:

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

-EventObjects

Event Objects to grant or revoke access to

Type: String[]
Parameter Sets: EndUserRemove, EndUserAdd
Aliases: viewEvent

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

-RestoreWithoutDownloadObjects

Objects which can be restored, with file download disabled

Type: String[]
Parameter Sets: EndUserRemove, EndUserAdd
Aliases: restoreWithoutDownload

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

-RestoreWithOverwriteObjects

Objects which can be restored, overwriting original

Type: String[]
Parameter Sets: EndUserRemove, EndUserAdd
Aliases: destructiveRestore

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

-OnDemandSnapshotObjects

Objects allowing On-Demand Snapshots

Type: String[]
Parameter Sets: EndUserRemove, EndUserAdd
Aliases: onDemandSnapshot

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

-ReportObjects

Report objects

Type: String[]
Parameter Sets: EndUserRemove, EndUserAdd
Aliases: viewReport

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

-RestoreObjects

Objects which can be restored

Type: String[]
Parameter Sets: EndUserRemove, EndUserAdd
Aliases: restore

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

-InfrastructureObjects

Infrastructure Objects allowing provisioning of restores/live mounts

Type: String[]
Parameter Sets: EndUserRemove, EndUserAdd
Aliases: provisionOnInfra

Required: False
Position: Named
Default value: @()
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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

CommonParameters

INPUTS

OUTPUTS

NOTES

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

RELATED LINKS

PreviousSet-RubrikUserNextSet-RubrikVCD

Last updated 4 years ago

Was this helpful?

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

about_CommonParameters
https://rubrik.gitbook.io/rubrik-sdk-for-powershell/command-documentation/reference/set-rubrikuserrole