Invoke-PAPromoteToMaster

Invoke-PAPromoteToMaster

Promote a RAS Publishing Agent to master.

Invoke-PAPromoteToMaster [-Server] <string> [[-SiteId] <uint>] [<CommonParameters>]

Invoke-PAPromoteToMaster [-Server] <string> [[-SiteId] <uint>] -Email <string> -Password <SecureString> [-Key <string>] [<CommonParameters>]

Invoke-PAPromoteToMaster [-Id] <uint> [<CommonParameters>]

Invoke-PAPromoteToMaster [-Id] <uint> -Email <string> -Password <SecureString> [-Key <string>] [<CommonParameters>]

Invoke-PAPromoteToMaster [-InputObject] <PA> [<CommonParameters>]

Invoke-PAPromoteToMaster [-InputObject] <PA> -Email <string> -Password <SecureString> [-Key <string>] [<CommonParameters>]

The Invoke-PAPromoteToMaster cmdlet is used to promote a RAS Publishing Agent to master.

-Server <string>
The name of the RAS Publishing Agent server.

This must be the actual server name used in the Parallels RAS farm.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint>
Site ID of the RAS Publishing Agent server.

If the parameter is omitted, the Licensing Server site ID will be used.

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Id <uint>
The ID of the RAS Publishing Agent server.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InputObject <PA>
An object of type PA representing the RAS Publishing Agent.

To obtain the object, use the Get-PA cmdlet.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false

-Email <string>
The email address you use to log in to Parallels My Account.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Password <SecureString>
Your Parallels account password.

If you omit this parameter, you'll get a prompt to enter the password.

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Key <string>
Parallels RAS License Key. The key must be registered in Parallels My Account.

To activate Parallels RAS as a trial, omit this parameter.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

<CommonParameters>

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation. 

PSAdmin.PA

---------- EXAMPLE 1 ----------

Invoke-PAPromoteToMaster "server.company.dom"

Promotes the specified RAS Publishing Agent (by server) to master.

---------- EXAMPLE 2 ----------

Invoke-PAPromoteToMaster -Id 5 -Email "name@company.com" -Password $SecretPass

Promotes the specified RAS Publishing Agent (by server) to master and activates a new RAS Publishing Agent license as a trial.

The $SecretPass variable must contain a password as SecureString.

If you omit the -Password parameter, you'll be asked to enter it when you execute the cmdlet.

---------- EXAMPLE 3 ----------

Invoke-PAPromoteToMaster -InputObject $PA -Email "name@company.com" -Password $SecretPass -Key "QPWO-WRET-XVBC-IOUP"

Promotes the specified RAS Publishing Agent (by server) to master and activates a new RAS Publishing Agent license using the specified key.

The $SecretPass variable must contain a password as SecureString.

If you omit the -Password parameter, you'll be asked to enter it when you execute the cmdlet.

---------- EXAMPLE 4 ----------

Get-PA -Id 2 | Invoke-PAPromoteToMaster

Promotes the specified (by InputObject) RAS Publishing Agent server to master.