NAME

Add-DcsRole

SYNOPSIS

Creates a custom user role and assigns privileges to the role.

SYNTAX

Add-DcsRole   -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

Creates a custom user role and assigns privileges to the role. The ability to view information in the software, which is one of the General privileges, is automatically added to each role.

PARAMETERS

-Name<String>

Name of the user role.

Required: true

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>

General privilege set grants privileges to users to perform general actions, such as viewing information in the software. Valid values include "All" to add the privilege set or "None" to remove the privilege set. The ability to view information in the software is automatically added to each role without this privilege being specified.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-Ports<PortPrivileges>

Ports privilege set grants privileges to users to perform actions on Fibre Channel and iSCSI ports. 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>

ClientMachines privilege set grants privileges to users to perform actions on hosts. 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>

HostGroups privilege set grants privileges to users to perform actions on host groups. 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>

ServerMachines privilege set grants privileges to users to perform actions on DataCore Servers. 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>

ServerMachineGroups privilege set grants privileges to users to perform actions on server groups. 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>

VirtualDisks privilege set grants privileges to users to perform actions on virtual disks. 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>

Snaphots privilege set grants privileges to users to perform actions on snapshots. 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>

Rollbacks privilege set grants privileges to users to perform actions on rollbacks. 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>

Replications privilege set grants privileges to users to perform actions on replications. 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>

PhysicalDisks privilege set grants privileges to users to perform actions on physical disks. 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>

DiskPools privilege set grants privileges to users to perform actions on disk pools. 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>

Controller privilege set grants privileges to users 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>

PartnerController privilege set grants privileges to users to perform actions on Replication Partner. 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>

Users privilege set grants privileges to users to perform actions on user accounts. 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>

Roles privilege set grants privileges to users to perform actions on user roles. 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>

StorageProfiles privilege set grants privileges to users to perform actions on storage profiles. 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>

Tasks privilege set grants privileges to users to perform actions on tasks. 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>

Monitors privilege set grants privileges to users 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>

Logs privilege set grants privileges to users to perform actions on event logs. 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>

VirtualDiskGroups privilege set grants privileges to users to perform actions on virtual disk groups. 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>

License privilege set grants privileges to users 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>

PerformanceRecording privilege set grants privileges to users to perform actions on performance recording sessions. 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>

VirtualDiskTemplate privilege set grants privileges to users to perform actions on virtual disk templates. 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 will be 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

OUTPUTS

RoleData : Object that identifies and describes the role.

NOTES

Also see Get-DcsRole, Remove-DcsRole.

EXAMPLES

Add-DcsRole -Name "Networking" -Description "Role for Network Administrators" -General ALL -Ports ALL -ClientMachines ALL -HostGroups ALL -ServerMachines ALL -ServerMachineGroups ALL -VirtualDisks ALL -Snapshots ALL -Rollbacks ALL -Replications ALL -PhysicalDisks ALL -DiskPools ALL -PartnerController ALL -Controller ALL -Tasks ALL -Monitors ALL -Logs ALL -VirtualDiskGroups ALL -PerformanceRecording ALL