Get-SCFabricRole

Gets a fabric role.

Syntax

Get-SCFabricRole
   [-VMMServer <ServerConnection>]
   -NetworkService <NetworkService>
   [-Name <String>]
   [-Type <FabricRoleType>]
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]
Get-SCFabricRole
   [-VMMServer <ServerConnection>]
   -ID <Guid>
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]

Description

The Get-SCFabricRole cmdlet gets a fabric role.

Examples

Example 1: Gets the existing fabric roles

PS C:\> $NetworkService = Get-SCNetworkService -Name "ns"
PS C:\> $FabricRole = Get-SCFabricRole -NetworkService $NetworkService -Name "fr"

The first command gets a network service by using the Get-SCNetworkService cmdlet, and then stores it in the $NetworkService variable.

The second command gets the existing fabric roles for the service in $NetworkService that have the specified name.

Required Parameters

-ID

Specifies the ID of the fabric role to get.

Type:Guid
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-NetworkService

Specifies a network service object.

Type:NetworkService
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-Name

Specifies the name of the fabric role to get.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-OnBehalfOfUser

Specifies a user name. This cmdlet operates on behalf of the user that this parameter specifies.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-OnBehalfOfUserRole

Specifies a user role. To obtain a user role, use the Get-SCUserRole cmdlet. This cmdlet operates on behalf of the user role that this parameter specifies.

Type:UserRole
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Type

Specifies the type. Valid values are:

  • Unknown
  • Gateway
  • LoadBalancer
Type:FabricRoleType
Parameter Sets:Unknown, Gateway, LoadBalancer
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-VMMServer

Specifies a Virtual Machine Manager (VMM) server object.

Type:ServerConnection
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False