Set-RASRule.md

NAME

Set-RASRule

SYNOPSIS

Modifies the Rule settings.

SYNTAX

Set-RASRule [Id] (uint) [[-SiteId] (uint)] -ObjType {ClientPolicy | PubItem} -RuleId (uint) [Description (string)] [Enabled (bool)] [-Priority {Up | Down}] [RuleName (string)] [(CommonParameters)]

Set-RASRule [-InputObject] (RASListObj) [[-SiteId] (uint)] -RuleId (uint) [Description (string)] [Enabled (bool)] [-Priority {Up | Down}] [RuleName (string)] [(CommonParameters)]

Set-RASRule [Name] (string) [[-SiteId] (uint)] -ObjType {ClientPolicy | PubItem} -RuleId (uint) [Description (string)] [Enabled (bool)] [-Priority {Up | Down}] [RuleName (string)] [(CommonParameters)]

DESCRIPTION

Modifies the Rule settings of Published Items.

PARAMETERS

RuleId (uint)

The ID of the Rule to modify.

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

Enabled (bool)

Whether the rule will be enabled or disabled.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

RuleName (string)

The modified name of the rule.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Description (string)

The modified description of the rule.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Priority (MoveDirection)

The direction to move the Rule: Up or Down (changes the priority of the Rule accordingly)

Possible values: Up, Down

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Name (string)

The name or server for which to modify the Rule settings.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

SiteId (uint)

Site ID for which to modify the Rule settings.

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 a server for which to modify the Rule settings.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

InputObject (RASListObj)

An object of type ClientPolicy or PubItem for which to modify the Rule settings.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

ObjType (RuleObjType)

The Object Type for which to modify the Rule settings.

Possible values: ClientPolicy, PubItem

        Required?                    true

        Position?                    named

        Default value                0

        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

-none-

OUTPUTS

-none-

EXAMPLES

**---------- EXAMPLE 1 ----------

Set-RASRule -Id 1 -ObjType ClientPolicy -RuleId 2 -Description Test

Modifies the description of the Rule with Id 2 from the Client Policy with Id 1.

RELATED LINKS

• Add-RASRule

• Get-RASRule

• Remove-RASRule