Get-VcsServiceRole

Syntax

• default
• IdParameterSet

Get-VcsServiceRole

[-Name  <String[]>]
[-Server  <IVcsServer[]>]
[-Service  <IVcsService[]>]
[CommonParameters]

---

Parameters

Required	Parameter Name	Type	Position	Features	Description
optional	Name	String[]	named		Specifies the names of the service roles you want to retrieve.
optional	Server	IVcsServer[]	named	wildcards	Specifies the VMware Cloud Services Platform servers 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 the Connect-Vcs cmdlet.
optional	Service	IVcsService[]	named	pipeline	Specifies the services whose roles you want to retrieve.

Get-VcsServiceRole

[-Id  <String[]>]
[-Server  <IVcsServer[]>]
[CommonParameters]

---

Parameters

Required	Parameter Name	Type	Position	Features	Description
optional	Id	String[]	named		Specifies the names of the service roles you want to retrieve.
optional	Server	IVcsServer[]	named	wildcards	Specifies the VMware Cloud Services Platform servers 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 the Connect-Vcs cmdlet.

Output

VMware.CloudServices.Types.V1.CmdletOutput.IVcsServiceRole

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.

Related Commands