Velostrata allows you to script actions from PowerShell using commands from a custom module. This document covers installing and using the built-in help within the PowerShell module.
- Download the installer, or open your Velostrata Manager and click the PowerShell module download icon on the home page.
Run the installation file and follow the wizard's directions. You must accept the Velostrata End User Service Agreement and choose an installation location.
The following PowerShell modules are installed:
You can now connect to Velostrata Manager by using:
PS C:\Users\Demo> Import-Module Velostrata.PowerShell PS C:\Users\Demo> Connect-VelostrataManager
The script prompts you for the IP of your Velostrata Manager.
When prompted for your user name, use
apiuser. The password is the one
you set when creating your Velostrata Manager.
Getting help from PowerShell
The PowerShell module provides help via the
PS C:\Users\Demo> Get-help Connect-VelostrataManager NAME Connect-VelostrataManager SYNOPSIS This cmdlet establishes a connection to a Velostrata Manager Server system. Connect-VelostrataManager [-Server] <String> [-Username] <String> [-Password] <SecureString> [-Port [<Int32>]] SYNTAX Connect-VelostrataManager [-Server] <String> [-Port <Int32>] [-Username] <String> [-Password] <SecureString> [<CommonParameters>] DESCRIPTION The cmdlet starts a new session or re-establishes a previous session with Velostrata Manager Server using the specified parameters. When you attempt to connect to a server, the server checks for valid credentials and then sets the relevant PSVariables. Once the user is authenticated successfully, the session remains in effect until the PowerShell session is closed or a new Velostrata Manager session is established. Note: You can have only one active connection to a Velostrata Manager server per PowerShell local session. REMARKS To see the examples, type: "get-help Connect-VelostrataManager -examples". For more information, type: "get-help Connect-VelostrataManager -detailed". For technical information, type: "get-help Connect-VelostrataManager -full". For online help, type: "get-help Connect-VelostrataManager -online"