PowerCLI Reference

Get-VcsServiceRole

Synopsis

This cmdlet retrieves service roles from the VMware Cloud Services Platform.

Syntax

Get-VcsServiceRole [-Id <String[]>] [-Server <CisServer[]>] [<CommonParameters>]

Get-VcsServiceRole [[-Name] <String[]>] [-Server <CisServer[]>] [-Service <IVcsService[]>] [<CommonParameters>]

Related Commands

Detailed Description

This cmdlet retrieves service roles from the VMware Cloud Services Platform.

Parameters

Name	Type	Description	Required?	Pipeline Input
Name	String[]	Specifies the names of the service roles you want to retrieve.	false	False
Id	String[]	Specifies the names of the service roles you want to retrieve.	false	False
Server	CisServer[]	Specifies the VMware Cloud Services Platform servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-Vcs cmdlet.	false	False
Service	IVcsService[]	Specifies the services whose roles you want to retrieve.	false	False

Return Type

VMware.CloudServices.Types.V1.CmdletOutput.IVcsUser

Notes

Examples

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

Get-VcsServiceRole -Id "ServiceRoleId"

Retrieves the service role with a "ServiceRoleId" ID.

-------------------------- Example 2 --------------------------

Get-VcsServiceRole -Name "ServiceRoleName"

Retrieves the service role with a "ServiceRoleName" name.

-------------------------- Example 3 --------------------------

Get-VcsServiceRole -Service $SERVICE

Retrieves the roles of the $SERVICE service.