Undo-vRAGroup¶

Synopsis¶

Removes a group in an organization.

Syntax¶

Undo-vRAGroup [-server] <String> [-user] <String> [-pass] <String> [-vraUser] <String> [-vraPass] <String> [-displayName] <String> [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description¶

The Undo-vRAGroup cmdlet removes a group in VMware Aria Automation. 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 Automation has been deployed in VMware Cloud Foundation aware mode and retrieves its details
Validates that network connectivity and authentication is possible to VMware Aria Automation
Removes the group from an organization role and all service roles.

Examples¶

Example 1¶

Undo-vRAGroup -server sfo-vcf01.sfo.rainpole.io -user administrator@vsphere.local -pass VMw@re1! -vraUser configadmin -vraPass VMw@re1! -displayName gg-vra-cloud-assembly-admins@rainpole.io

This example removes a group from VMware Aria Automation by displayName.

Parameters¶

-server¶

The fully qualified domain name of the SDDC Manager.

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.

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.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-vraUser¶

The VMware Aria Automation user name.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-vraPass¶

The VMware Aria Automation password.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-displayName¶

The group display name.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction¶

Progress Action

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
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.