Get-VIPrivilege

NAME Get-VIPrivilege



SYNOPSIS

This cmdlet retrieves the privilege groups and items for the provided servers.





SYNTAX

Get-VIPrivilege [[-Name] <String[]>] [-Group] <PrivilegeGroup[]> [-Id <String[]>] [<CommonParameters>]



Get-VIPrivilege [[-Name] <String[]>] [-Id <String[]>] [-PrivilegeGroup] [-PrivilegeItem] [-Server <VIServer[]>]

[<CommonParameters>]



Get-VIPrivilege [[-Name] <String[]>] [-Role] <Role[]> [-Id <String[]>] [<CommonParameters>]





DESCRIPTION

This cmdlet retrieves the privilege groups and items for the provided servers.





PARAMETERS

-Group <PrivilegeGroup[]>

Specifies the privilege group whose items you want to retrieve.



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? true



-Id <String[]>

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.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? true



-Name <String[]>

Specifies the names of the privileges you want to retrieve.



Required? false

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? true



-PrivilegeGroup [<SwitchParameter>]

Indicates that you want to retrieve only the privilege groups and not the privilege items in them.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-PrivilegeItem [<SwitchParameter>]

Indicates that you want to retrieve only the privilege items and not the privilege groups.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Role <Role[]>

Specifies the roles whose privileges you want to retrieve.



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? true



-Server <VIServer[]>

Specifies the vCenter Server systems on which you want to run the cmdlet. If no 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.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? true



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

Zero or more Privilege objects







NOTES









-------------------------- 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 LINKS

Online Version: https://code.vmware.com/doc/preview?id= ... ilege.html

Get-VIRole

New-VIRole

Remove-VIRole

Set-VIRole