PowerCLI Reference

New-VcsUserInvitation

Synopsis

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

Syntax

New-VcsUserInvitation [-Email] <String[]> -OrganizationRole <IVcsOrganizationRole[]> [-Server <CisServer[]>] [-ServiceRole <IVcsServiceRole[]>] [<CommonParameters>]

Related Commands

Detailed Description

This cmdlet creates a 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.

Parameters

Name	Type	Description	Required?	Pipeline Input
Email	String[]	Specifies the emails of the users you want to invite.	true	False
OrganizationRole	IVcsOrganizationRole[]	Specifies the organization roles which you want to apply for the user.	true	False
Server	CisServer[]	Specifies the VMware Cloud Services Platform servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-Vcs cmdlet.	false	False
ServiceRole	IVcsServiceRole[]	Specifies the service roles that you want to apply for the user.	false	False

Return Type

VMware.CloudServices.Types.V1.CmdletOutput.IVcsUserInvitation

Notes

Examples

-------------------------- Example 1 --------------------------

New-VcsUserInvitation -Email "email@mail.com" -OrganizationRole $organizationRoles -ServiceRole $serviceRoles

Creates a new user invitation for the user with an email "email@mail.com". Users organization roles are $organizationRoles. Users service roles are $serviceRoles.