Set-RoyalDocumentPassword

Set-RoyalDocumentPassword

Scripting > Reference > PowerShell Commandlets >

NAME

Set-RoyalDocumentPassword
 
 

 

SYNOPSIS

Sets the password of a RoyalDocument.
 
 
 

 

SYNTAX

Set-RoyalDocumentPassword [-Document] <RoyalDocument> [[-NewPassword] <SecureString>] [[-OldPassword]
<SecureString>] [[-Interactive] <SwitchParameter>] [<CommonParameters>]
 
 
 

 

DESCRIPTION

This cmdlet sets the password of a RoyalDocument.
 
 

 

PARAMETERS

-Document <RoyalDocument>
The RoyalDocument of which the password is set.
 
Required? true
Position? 0
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
 
-NewPassword <SecureString>
The new password.
 
Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
 
-OldPassword <SecureString>
The old password of the RoyalDocument.
 
Required? false
Position? 2
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
 
-Interactive <SwitchParameter>
If the password should not be specified in a script, use this option to let the user enter it interactively.
 
Required? false
Position? 3
Default value False
Accept pipeline input? true (ByValue, ByPropertyName)
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 (https:/go.microsoft.com/fwlink/?LinkID=113216).
 
 

 

INPUTS

RoyalDocumentLibrary.RoyalDocument
The RoyalDocument of which the password is set.
 
System.Security.SecureString
The new password.
 
System.Management.Automation.SwitchParameter
If the password should not be specified in a script, use this option to let the user enter it interactively.
 
 
 

 

OUTPUTS

 
---------- EXAMPLE 1 ----------
 
Set-RoyalDocumentPassword -Document $document -OldPassword $oldPwd -Password $newPwd -Interactive
 
$oldPwd and $newPwd are SecureStrings. Use (Read-Host -AsSecureString "Password") or ConvertTo-SecureString. If the
-Interactive switch is specified, the cmdlet is asking for the password.
 
 

 

RELATED LINKS

New-RoyalObject

Out-RoyalDocument

Move-RoyalObject

Copy-RoyalObject

Get-RoyalObject