-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add support for vrslcm role assignment (#564)
- Added `Get-vRSLCMRole` cmdlet to retrieve a list of VMware Aria Suite Lifecycle roles. - Added `Get-vRSLCMGroup` cmdlet to retrieve a list of VMware Aria Suite Lifecycle group assignments. - Added `Add-vRSLCMGroup` cmdlet to add a group to a roles in VMware Aria Suite Lifecycle. - Added `Remove-vRSLCMGroup` cmdlet to remove the role assignments for a group in VMware Aria Suite Lifecycle. - Added `Add-vRLCMSGroupRole` cmdlet to add roles to groups in VMware Aria Suite Lifecycle. - Added `Undo-vRLCMSGroupRole` cmdlet to remove group roles in VMWare Aria Suite Lifecycle. - Enhanced `Invoke-GlobalWsaDeployment` cmdlet to use `Add-vRLCMSGroupRole` to configure VMware Aria Suite Lifecycle roles. Signed-off-by: Gary Blake <gblake@vmware.com>
- Loading branch information
1 parent
7e0d364
commit a5ca74e
Showing
10 changed files
with
747 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
63 changes: 63 additions & 0 deletions
63
docs/documentation/functions/aria-suite/aria-suite-lifecycle/Add-vRSLCMGroup.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
# Add-vRSLCMGroup | ||
|
||
## Synopsis | ||
|
||
Assign a group to a VMware Aria Suite Lifecycle role. | ||
|
||
## Syntax | ||
|
||
``` PowerShell | ||
Add-vRSLCMGroup [-group] <String> [-role] <String> [<CommonParameters>] | ||
``` | ||
|
||
## Description | ||
|
||
The `Add-vRSLCMGroup` cmdlet assigns a group to a VMware Aria Suite Lifecycle roles. | ||
|
||
## Examples | ||
|
||
### Example 1 | ||
|
||
``` PowerShell | ||
Add-vRSLCMGroup -group gg-vrslcm-admins -role "LCM Admin" | ||
``` | ||
|
||
This example assigns a group to a the LCM Admin in VMware Aria Suite Lifecycle. | ||
|
||
## Parameters | ||
|
||
### -group | ||
|
||
The group to assign the VMware Aria Suite Lifecycle role to. | ||
|
||
```yaml | ||
Type: String | ||
Parameter Sets: (All) | ||
Aliases: | ||
|
||
Required: True | ||
Position: 1 | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
### -role | ||
The VMware Aria Suite Lifecycle role to assign (consists of LCM Admin, Content Developer, Content Release Manager, Certificate Administrator, VCF Role). | ||
```yaml | ||
Type: String | ||
Parameter Sets: (All) | ||
Aliases: | ||
|
||
Required: True | ||
Position: 2 | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
### Common Parameters | ||
This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). |
115 changes: 115 additions & 0 deletions
115
.../documentation/functions/aria-suite/aria-suite-lifecycle/Add-vRSLCMGroupRole.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,115 @@ | ||
# Add-vRSLCMGroupRole | ||
|
||
## Synopsis | ||
|
||
Assigns a group from the authentication provider with a role in VMware Aria Suite Lifecycle. | ||
|
||
## Syntax | ||
|
||
``` PowerShell | ||
Add-vRSLCMGroupRole [-server] <String> [-user] <String> [-pass] <String> [-group] <String> [-role] <String> [<CommonParameters>] | ||
``` | ||
|
||
## Description | ||
|
||
The `Add-vRSLCMGroupRole` cmdlet assigns access to a group from the authentication provider. | ||
The cmdlet connects to SDDC Manager using the -server, -user, and -password values: | ||
|
||
- Validates that network connectivity and authentication is possible to SDDC Manager | ||
- Validates that VMware Aria Suite Lifecycle has been deployed in VCF-aware mode and retrieves its details | ||
- Validates that the group has not already been assigned access to VMware Aria Suite Lifecycle | ||
- Adds the group to the access control assigning the role provided in VMware Aria Suite Lifecycle | ||
|
||
## Examples | ||
|
||
### Example 1 | ||
|
||
``` PowerShell | ||
Add-vRSLCMGroupRole -server sfo-vcf01.sfo.rainpole.io -user administrator@vsphere.local -pass VMw@re1! -group gg-vrslcm-admins@sfo.rainpole.io -role 'LCM Admin' | ||
``` | ||
|
||
This example adds the group gg-vrslcms-admins with the LCM Admin role in VMware Aria Suite Lifecycle. | ||
|
||
## Parameters | ||
|
||
### -server | ||
|
||
The fully qualified domain name of the SDDC Manager. | ||
|
||
```yaml | ||
Type: String | ||
Parameter Sets: (All) | ||
Aliases: | ||
|
||
Required: True | ||
Position: 1 | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
### -user | ||
The username to authenticate to the SDDC Manager. | ||
```yaml | ||
Type: String | ||
Parameter Sets: (All) | ||
Aliases: | ||
|
||
Required: True | ||
Position: 2 | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
### -pass | ||
The password to authenticate to the SDDC Manager. | ||
```yaml | ||
Type: String | ||
Parameter Sets: (All) | ||
Aliases: | ||
|
||
Required: True | ||
Position: 3 | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
### -group | ||
The group name. | ||
```yaml | ||
Type: String | ||
Parameter Sets: (All) | ||
Aliases: | ||
|
||
Required: True | ||
Position: 4 | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
### -role | ||
The role to assign to the group 'LCM Admin', 'Content Developer', 'Content Release Manager', 'Certificate Administrator', 'VCF Role'. | ||
```yaml | ||
Type: String | ||
Parameter Sets: (All) | ||
Aliases: | ||
|
||
Required: True | ||
Position: 5 | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
### Common Parameters | ||
This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). |
54 changes: 54 additions & 0 deletions
54
docs/documentation/functions/aria-suite/aria-suite-lifecycle/Get-vRSLCMGroup.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
# Get-vRSLCMGroup | ||
|
||
## Synopsis | ||
|
||
Retrieve group assignments in VMware Aria Suite Lifecycle. | ||
|
||
## Syntax | ||
|
||
``` PowerShell | ||
Get-vRSLCMGroup [[-providerVmid] <String>] [<CommonParameters>] | ||
``` | ||
|
||
## Description | ||
|
||
The `Get-vRSLCMGroup` cmdlet retrieves a list of group assignments in VMware Aria Suite Lifecycle. | ||
|
||
## Examples | ||
|
||
### Example 1 | ||
|
||
``` PowerShell | ||
Get-vRSLCMGroup | ||
``` | ||
|
||
This example retrieves a list of VMware Aria Suite Lifecycle group assignments. | ||
|
||
### Example 2 | ||
|
||
``` PowerShell | ||
Get-vRSLCMGroup -providerVmid 2d90903c-b753-4f52-905e-5421d11f6572 | ||
``` | ||
This example retrieves a list of VMware Aria Suite Lifecycle group assignments for the given identity provider. | ||
|
||
## Parameters | ||
|
||
### -providerVmid | ||
|
||
The vmid for the provider. | ||
|
||
```yaml | ||
Type: String | ||
Parameter Sets: (All) | ||
Aliases: | ||
|
||
Required: False | ||
Position: 1 | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
### Common Parameters | ||
This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). |
25 changes: 25 additions & 0 deletions
25
docs/documentation/functions/aria-suite/aria-suite-lifecycle/Get-vRSLCMRole.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Get-vRSLCMRole | ||
|
||
## Synopsis | ||
|
||
Retrieve VMware Aria Suite Lifecycle roles. | ||
|
||
## Syntax | ||
|
||
``` PowerShell | ||
Get-vRSLCMRole | ||
``` | ||
|
||
## Description | ||
|
||
The Get-vRSLCMRole cmdlet retrieves a list of VMware Aria Suite Lifecycle roles. | ||
|
||
## Examples | ||
|
||
### Example 1 | ||
|
||
``` PowerShell | ||
Get-vRSLCMRole | ||
``` | ||
|
||
This example retrieves a list of VMware Aria Suite Lifecycle roles. |
47 changes: 47 additions & 0 deletions
47
docs/documentation/functions/aria-suite/aria-suite-lifecycle/Remove-vRSLCMGroup.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
# Remove-vRSLCMGroup | ||
|
||
## Synopsis | ||
|
||
Remove a group and its role assignments from VMware Aria Suite Lifecycle. | ||
|
||
## Syntax | ||
|
||
``` PowerShell | ||
Remove-vRSLCMGroup [-vmid] <String> [<CommonParameters>] | ||
``` | ||
|
||
## Description | ||
|
||
The `Remove-vRSLCMGroup` cmdlet removes a group and its role assignments from VMware Aria Suite Lifecycle. | ||
|
||
## Examples | ||
|
||
### Example 1 | ||
|
||
``` PowerShell | ||
Remove-vRSLCMGroup -vmid a3f18959-00b1-4703-a9ab-fad5de8efa84 | ||
``` | ||
|
||
This example removes a group and its role assignments from VMware Aria Suite Lifecycle. | ||
|
||
## Parameters | ||
|
||
### -vmid | ||
|
||
The unique identifier of the group in VMware Aria Sute Lifecycle. | ||
|
||
```yaml | ||
Type: String | ||
Parameter Sets: (All) | ||
Aliases: | ||
|
||
Required: True | ||
Position: 1 | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
### Common Parameters | ||
This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). |
Oops, something went wrong.