NAME

Set-DcsRoleProperties

SYNOPSIS

Sets or changes the properties of a user role.

SYNTAX

Set-DcsRoleProperties   -Role <Object>   [ -Name <String> ]   [ -Description <String> ]   [ -General <GeneralPrivileges> ]   [ -Ports <PortPrivileges> ]   [ -ClientMachines <ClientMachinePrivileges> ]   [ -HostGroups <HostGroupPrivileges> ]   [ -ServerMachines <ServerMachinePrivileges> ]   [ -ServerMachineGroups <ServerMachineGroupPrivileges> ]   [ -VirtualDisks <VirtualDiskPrivileges> ]   [ -Snapshots <SnapshotPrivileges> ]   [ -Rollbacks <RollbackPrivileges> ]   [ -Replications <ReplicationPrivileges> ]   [ -PhysicalDisks <PhysicalDiskPrivileges> ]   [ -DiskPools <DiskPoolPrivileges> ]   [ -Controller <ExecutivePrivileges> ]   [ -PartnerController <PartnerControllerPrivileges> ]   [ -Users <UserPrivileges> ]   [ -Roles <RolePrivileges> ]   [ -StorageProfiles <StorageProfilePrivileges> ]   [ -Tasks <TaskPrivileges> ]   [ -Monitors <MonitorPrivileges> ]   [ -Logs <LogPrivileges> ]   [ -VirtualDiskGroups <VirtualDiskGroupPrivileges> ]   [ -License <LicensePrivileges> ]   [ -PerformanceRecording <PerformanceRecordingPriviledges> ]   [ -VirtualDiskTemplate <VirtualDiskTemplatePrivileges> ]   [ -Witness <WitnessPrivileges> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Sets or changes the properties of a user role. Specify the parameters to set or change. The ability to view information in the software, a privilege in the General privilege set, cannot be removed from a role.

PARAMETERS

-Role<Object>

RoleData object, ID, or alias that identifies the role. The RoleData object can be obtained from the cmdlet Get-DcsRole.

Required: true

Position: 1

Default value:

Accept pipeline input: true (ByValue)

Accept wildcard characters: false

-Name<String>

Name of the user role.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-Description<String>

Description of the user role.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-General<GeneralPrivileges>

Adds or removes the General privilege set, which grants general privileges such as viewing information. Valid values include "All" to add the privilege set or "None" to remove the privilege set. The ability to view information in the software, a privilege in the General privilege set, cannot be removed from a role.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-Ports<PortPrivileges>

Adds or removes the Ports privilege set. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-ClientMachines<ClientMachinePrivileges>

Adds or removes the ClientMachines privilege set. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-HostGroups<HostGroupPrivileges>

Adds or removes the HostGroups privilege set. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-ServerMachines<ServerMachinePrivileges>

Adds or removes the ServerMachines privilege set. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-ServerMachineGroups<ServerMachineGroupPrivileges>

Adds or removes the ServerMachineGroups privilege set. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-VirtualDisks<VirtualDiskPrivileges>

Adds or removes the VirtualDisks privilege set. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-Snapshots<SnapshotPrivileges>

Adds or removes the Snapshots privilege set. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-Rollbacks<RollbackPrivileges>

Adds or removes the Rollbacks privilege set. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-Replications<ReplicationPrivileges>

Adds or removes the Replications privilege set. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-PhysicalDisks<PhysicalDiskPrivileges>

Adds or removes the PhysicalDisks privilege set. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-DiskPools<DiskPoolPrivileges>

Adds or removes the DiskPools privilege set. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-Controller<ExecutivePrivileges>

Adds or removes the Controller privilege set, which grants privileges to perform actions on service level operations. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-PartnerController<PartnerControllerPrivileges>

Adds or removes the PartnerController privilege set, which grants privileges to perform actions on Replication Partners. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-Users<UserPrivileges>

Adds or removes the Users privilege set. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-Roles<RolePrivileges>

Adds or removes the Roles privilege set. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-StorageProfiles<StorageProfilePrivileges>

Adds or removes the StorageProfiles privilege set. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-Tasks<TaskPrivileges>

Adds or removes the Tasks privilege set. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-Monitors<MonitorPrivileges>

Adds or removes the Monitors privilege set, which grants privileges to perform actions on system health monitors. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-Logs<LogPrivileges>

Adds or removes the Logs privilege set. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-VirtualDiskGroups<VirtualDiskGroupPrivileges>

Adds or removes the VirtualDiskGroups privilege set. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-License<LicensePrivileges>

Adds or removes the License privilege set, which grants privileges to perform actions on software licenses. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-PerformanceRecording<PerformanceRecordingPriviledges>

Adds or removes the PerformanceRecording privilege set. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-VirtualDiskTemplate<VirtualDiskTemplatePrivileges>

Adds or removes the VirtualDiskTemplate privilege set. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-Witness<WitnessPrivileges>

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-Connection<String>

Alias of the connection to the server group. If not specified, the default connection is used.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-PipelineVariable<String>

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

INPUTS

RoleData : Object that identifies the role.

OUTPUTS

RoleData : Object that identifies the role.

NOTES

Also see Add-DcsRole, Get-DcsRole, Remove-DcsRole.

EXAMPLES

Set-DcsRoleProperties -Role "RoleY" -VirtualDisks All -Snapshots All -Rollbacks All -Ports None