Set-RASPA

NAME

Set-RASPA

SYNOPSIS

Modifies settings of a RAS Publishing Agent server.

SYNTAX

Set-RASPA [-Server] <string> [[-SiteId] <uint>] [-AlternativeIPs <string>] [-Description <string>] [-Enabled <bool>] [-IP <string>] [-Standby <bool>] [<CommonParameters>]

Set-RASPA [-Id] <uint> [-AlternativeIPs <string>] [-Description <string>] [-Enabled <bool>] [-IP <string>] [-Standby <bool>] [<CommonParameters>]

Set-RASPA [-InputObject] <PA> [-AlternativeIPs <string>] [-Description <string>] [-Enabled <bool>] [-IP <string>] [-Standby <bool>] [<CommonParameters>]

DESCRIPTION

Modifies settings of a RAS Publishing Agent server.

For each setting, the cmdlet has a corresponding input parameter. To modify a setting, specify a parameter and its value.

PARAMETERS


-Server <string>
The name of the target 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 in which the target RAS Publishing Agent resides.

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

        Required?                    false
        Position?                    1
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-Id <uint>
The RAS Publishing Agent server ID. To obtain the ID, use the command to Get PA(s). 

        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

-Enabled <bool>
Enable or disable the specified RAS Publishing Agent. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-Description <string>
A user-defined RAS Publishing Agent description. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-IP <string>
An IP address of the RAS Publishing Agent server. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-AlternativeIPs <string>
A list of alternative IP addresses separated by a comma. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-Standby <bool>
Set the specified RAS Secondary PA in Standby (or vice versa). 

        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.

INPUTS

PA

OUTPUTS

-none-

EXAMPLES


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

Set-RASPA -Server "server.company.dom" -Enable $False

Disables the specified RAS Publishing Agent in the Licensing Server site.

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

Set-RASPA -Id 3 -Enable $False

Disables the RAS Publishing Agent specified by ID.

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

Set-RASPA $PA -Enable $True

Enables the RAS Publishing Agent specified by the $PA variable, which is an object of type PA.

The object is obtained using the Get-RASPA cmdlet.

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

Get-RASPA -Id 3 | Set-RASPA -Enable $True

Enables the RAS Publishing Agent represented by a PA object obtained from the pipeline output.

RELATED LINKS