Short Description
Modifies RESTful API settings.
Syntax
Set-VBORestAPISettings [-EnableService [<SwitchParameter>]] [-AuthTokenLifeTime <Int32>] [-HTTPSPort <Int32>] [-CertificateFilePath <String>] [-CertificatePassword <SecureString>] [<CommonParameters>] |
Detailed Description
This cmdlet modifies RESTful API settings which are used by Veeam Backup for Microsoft Office 365 RESTful API Service. For SSL connections, Veeam Backup for Microsoft Office 365 RESTful API uses SSL certificate.
|
This cmdlet accepts SecureString type. Use Microsoft PowerShell standard capabilities to convert your password into the SecureString. |
Parameters
Parameter | Description | Required | Position | Accept | Accept |
Enable | Indicates that the cmdlet will start Veeam Backup for Microsoft Office 365 RESTful API Service. | False | Named | False | False |
AuthToken | 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 |
Certificate | Specifies the path to SSL certificate file. | False | Named | False | False |
Certificate | Specifies the password for SSL certificate. | False | Named | False | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Example
This example shows how to modify RESTful 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 ConvertTo-SecureString with the $plainpassword variable to turn the password into SecureString type. Save the result to the $securepassword variable.
- Run Set-VBORestAPISettings with the $securepassword variable.
The password is turned into a SecureString by running ConvertTo-SecureString and assigned to the $securepassword variable.
PS C:\PS> $plainpassword = "Password1234plain" PS C:\PS> $securepassword = $plainpassword | ConvertTo-SecureString -AsPlainText -Force PS C:\PS> Set-VBORestAPISettings -EnableService -AuthTokenLifeTime 4800 -CertificateFilePath "C:\Certificates" -CertificatePassword $securepassword |
