New-VcsUserInvitation Command | Vmware PowerCLI Reference

New-VcsUserInvitation

This cmdlet creates а new user invitation on the VMware Cloud Services Platform. If no pending invitation is created, the user might be registered. You can check if the user is added successfully by using the Get-VcsUser cmdlet.

Syntax

New-VcsUserInvitation
-Email < String[] >
-OrganizationRole < IVcsOrganizationRole[] >
[-ProgressAction < ActionPreference > ]
[-Server < IVcsServer[] > ]
[-ServiceRole < IVcsServiceRole[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Email String[] named
Specifies the emails of the users you want to invite.
required
OrganizationRole IVcsOrganizationRole[] named
  • wildcards
Specifies the organization roles which you want to apply for the user.
optional ProgressAction ActionPreference named
optional Server IVcsServer[] named
  • wildcards
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 ServiceRole IVcsServiceRole[] named
  • wildcards
Specifies the service roles that you want to apply for the user.

Output

VMware.CloudServices.Types.V1.CmdletOutput.IVcsUserInvitation

Examples

Example 1

New-VcsUserInvitation -Email "[email protected]" -OrganizationRole $organizationRoles -ServiceRole $serviceRoles

Creates a new user invitation for the user with an email "[email protected]". Users organization roles are $organizationRoles. Users service roles are $serviceRoles.

Related Commands

VcsUser

This cmdlet retrieves users from the VMware Cloud Services Platform.

This cmdlet removes a user from the VMware Cloud Services Platform.

VcsUserInvitation

This cmdlet retrieves user invitations from the VMware Cloud Services Platform.

This cmdlet creates а new user invitation on the VMware Cloud Services Platform.

This cmdlet revokes a user invitation from the VMware Cloud Services Platform.