Get-VIRole

NAME Get-VIRole



SYNOPSIS

This cmdlet retrieves all roles defined on the provided servers.





SYNTAX

Get-VIRole [[-Name] <String[]>] [-Id <String[]>] [-Server <VIServer[]>] [<CommonParameters>]





DESCRIPTION

This cmdlet retrieves all roles defined on the provided servers.





PARAMETERS

-Id <String[]>

Specifies the IDs of the roles 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 roles you want to retrieve.



Required? false

Position? 1

Default value None

Accept pipeline input? False

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 Role objects







NOTES









-------------------------- Example 1 --------------------------



Get-VIRole -Server $server -Name "Admin*"



Retrieves all roles on the specified server with names that start with "Admin".



RELATED LINKS

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

New-VIRole

Remove-VIRole

Set-VIRole

Get-VIPrivilege

Get-VIPermission

New-VIPermission

Remove-VIPermission

Set-VIPermission