Get-VcsServiceRole
This cmdlet retrieves service roles from the VMware Cloud Services Platform.
Syntax
[-Name
< String[] > ]
[-ProgressAction
< ActionPreference > ]
[-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 | ProgressAction | ActionPreference | named |
|
|
| optional | Server | IVcsServer[] | named |
|
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 |
|
Specifies the services whose roles you want to retrieve. |
[-Id
< String[] > ]
[-ProgressAction
< ActionPreference > ]
[-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 | ProgressAction | ActionPreference | named |
|
|
| optional | Server | IVcsServer[] | named |
|
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.IVcsServiceRoleExamples
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
VcsService
This cmdlet retrieves services from the VMware Cloud Services Platform.
VcsServiceRole
This cmdlet retrieves service roles from the VMware Cloud Services Platform.