This is an archive version of the document. To get the most up-to-date information, see the current version.Set-VBORestAPISettings
Short Description
Modifies REST API settings.
Syntax
Set-VBORestAPISettings [-EnableService [<SwitchParameter>]] [-AuthTokenLifeTime <Int32>] [-HTTPSPort <Int32>] [-CertificateFilePath <String>] [-CertificatePassword <SecureString>] [<CommonParameters>] |
Detailed Description
This cmdlet modifies REST API settings which are used by Veeam Backup for Microsoft Office 365 REST API Service. For SSL connections, Veeam Backup for Microsoft Office 365 REST API uses SSL certificate.
|
This cmdlet accepts the SecureString type. Use Microsoft PowerShell standard capabilities to convert your password into the SecureString. |
Parameters
Parameter | Description | Required | Position | Accept Pipeline Input | Accept Wildcard Characters |
|---|---|---|---|---|---|
EnableService | Indicates that the cmdlet will start Veeam Backup for Microsoft Office 365 REST API Service. | False | Named | False | False |
AuthTokenLifeTime | Specifies the lifetime value for the authentication token (minutes). | False | Named | False | False |
HTTPSPort | Specifies the port for server-client communication over HTTPS protocol. | False | Named | False | False |
CertificateFilePath | Specifies the path to SSL certificate file. | False | Named | False | False |
CertificatePassword | Specifies the password for SSL certificate. | False | Named | False | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.
Examples
Example 1
This example shows how to modify REST API settings:
- Set authentication token lifetime to 4800 minutes
- Locate the SSL certificate file and type certificate's password
You will need to perform the following steps:
- Assign your certificate password to the $plainpassword variable.
- Run the ConvertTo-SecureString cmdlet with the $plainpassword variable to turn the password into the SecureString type. Save the result to the $securepassword variable.
- Run the Set-VBORestAPISettings cmdlet with the $securepassword variable.
The password is turned into a SecureString by running ConvertTo-SecureString and assigned to the $securepassword variable.
$plainpassword = "Password1234plain" $securepassword = $plainpassword | ConvertTo-SecureString -AsPlainText -Force Set-VBORestAPISettings -EnableService -AuthTokenLifeTime 4800 -CertificateFilePath "C:\Certificates" -CertificatePassword $securepassword |