Get-XenRole
Gets the Role objects in the pool.
Syntax
Get-XenRole [[-Ref] <XenRef[Role]>] [-BestEffort] [-SessionOpaqueRef <string>]
[<CommonParameters>]
Get-XenRole [-Uuid] <guid> [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenRole [-Name] <string> [-BestEffort] [-SessionOpaqueRef <string>]
[<CommonParameters>]
Description
Retrieves the Role objects in the pool. With no parameters the cmdlet returns the whole collection; use -Name, -Uuid or -Ref to select one.
Role: A set of permissions associated with a subject.
Parameters
-BestEffort
If set, the cmdlet continues processing further objects instead of throwing a terminating error when an operation fails for one object.
| Attribute | Value |
|---|---|
| Type | SwitchParameter |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-Name
The name of the Role to operate on.
| Attribute | Value |
|---|---|
| Type | string |
| Required | True |
| Position | 0 |
| Accepts pipeline input | True (ByPropertyName) |
| Aliases | name_label |
-Ref
The Role object to operate on, specified by its opaque reference.
| Attribute | Value |
|---|---|
| Type | XenRef[Role] |
| Required | False |
| Position | 0 |
| Accepts pipeline input | True (ByPropertyName) |
| Aliases | opaque_ref |
-SessionOpaqueRef
The session object on which to run the cmdlet. This overrides the default session and lets you target a specific open XenServer connection.
| Attribute | Value |
|---|---|
| Type | string |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-Uuid
The UUID of the Role to operate on.
| Attribute | Value |
|---|---|
| Type | guid |
| Required | True |
| Position | 0 |
| Accepts pipeline input | True (ByPropertyName) |
Inputs
-
XenRef[Role] -
guid -
string
Outputs
-
Role[]
Examples
Example 1: List every Role
PS> Get-XenRole
Retrieves every Role object in the pool. With no parameters the cmdlet fetches the whole collection.
Example 2: Retrieve one Role by name
PS> Get-XenRole -Name "Demo Role"
Retrieves a single Role. -Name matches on name\_label, which is not unique, so every match is operated on.
Example 3: Retrieve one Role by uuid
PS> Get-XenRole -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
Retrieves a single Role. -Uuid is the way to be sure of exactly one object.
Related links
-
Class: Role
-
Using the XenServer PowerShell module