Get-VIPrivilege
This cmdlet retrieves the privilege groups and items for the provided servers.
Syntax
[-Id
<String[]>]
[-Name <String[]>]
[-PrivilegeGroup]
[-PrivilegeItem]
[-Server <VIServer[]>]
[CommonParameters]
[-Name <String[]>]
[-PrivilegeGroup]
[-PrivilegeItem]
[-Server <VIServer[]>]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| optional |
|
String[] | named |
|
Specifies the IDs of the privileges you want to retrieve. Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list. | optional |
|
String[] | named |
|
Specifies the names of the privileges you want to retrieve. | optional |
|
SwitchParameter | named |
|
Indicates that you want to retrieve only the privilege groups and not the privilege items in them. | optional |
|
SwitchParameter | named |
|
Indicates that you want to retrieve only the privilege items and not the privilege groups. | optional |
|
VIServer[] | named |
|
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer. |
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
PrivilegeGroup[] | 1 |
|
Specifies the privilege group whose items you want to retrieve. | optional |
|
String[] | named |
|
Specifies the IDs of the privileges you want to retrieve. Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list. | optional |
|
String[] | named |
|
Specifies the names of the privileges you want to retrieve. |
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
Role[] | 1 |
|
Specifies the roles whose privileges you want to retrieve. | optional |
|
String[] | named |
|
Specifies the IDs of the privileges you want to retrieve. Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list. | optional |
|
String[] | named |
|
Specifies the names of the privileges you want to retrieve. |
Output
VMware.VimAutomation.ViCore.Types.V1.PermissionManagement.Privilege
Examples
Example 1
Get-VIPrivilege -Name "Host*"
Retrieves all privileges with names that start with "Host".
Example 2
Get-VIPrivilege -PrivilegeGroup
Retrieves all privilege groups.
Related Commands
VIPrivilege
This cmdlet retrieves the privilege groups and items for the provided servers.
