Connects to a Milestone XProtect VMS Management Server.
This command is used to authenticate with, and connect to one or more Milestone
XProtect VMS Management Servers. It is required to use
Connect-ManagementServer before using a great many cmdlets in the
Supported authentication options match those of XProtect Management Client and XProtect Smart Client including the current Windows user, a specified Windows user, or a Milestone basic user.
When using MilestonePSTools interactively, you may opt to use a GUI-based login
dialog by including the
-ShowDialog switch parameter.
When connecting to a parent management server in a Milestone Federated
Architecture hierarchy, you may use the
-IncludeChildSites switch, and you
will automatically authenticate with each child site, recursively, in the
- Does not require a VMS connection
Prompts the user with a familiar Milestone login dialog to login to the
Management Server. With
-ErrorAction Stop, a failure to authenticate will
prevent the next command from running.
Get-VmsHardware returns information for all hardware devices on all
recording servers in the current site.
Disconnect-ManagementServer logs out gracefully.
Prompts the user with a familiar Milestone login dialog to login to the Management Server and prevents automatic login in case that was used previously and isn't wanted now.
This command authenticates with a server named mgtsrv1 where the server is listening on HTTP port 80, and it uses the current PowerShell user context.
If you have opened PowerShell normally, as your current Windows user, then the credentials used will be that of your current Windows user.
If you have opened PowerShell as a different user (shift-right-click, run as a different user), OR you are executing your script as a scheduled task, the user context will be that of whichever user account was used to start the PowerShell session.
This command will prompt the user for a username and password, then authenticates with a server named mgtsrv1 where the server is listening on HTTP port 80 using Windows authentication.
This command authenticates with a server named mgtsrv1 where the server is listening on HTTPS port 443, and it authenticates a basic user using the credentials supplied in the Get-Credential pop-up
Note: As a "Basic User", the user will not have access to child sites in a Milestone Federated Architecture and thus the -IncludeChildSites switch will not have any effect.
Acknowledge you have read and accept the end-user license agreement for the
redistributable MIP SDK package. This command is required on the first use of
Connect-ManagementServer for the current Windows user.
Note: A 0-byte file is placed at
%appdata%\MilestonePSTools\user-accepted-eula.txt once the agreement has been accepted.
Use Milestone's Basic User authentication instead of Windows or Active Directory.
Specifies a user account that has permission to login to the Milestone XProtect VMS Management Server. This can be a Windows, Active Directory, or Milestone basic user.
- When omitted, authentication will proceed with the current Windows user.
- When specifying credentials for a basic user, you must also provide the
Disables and prevents auto-login when showing the login dialog.
Disconnect-ManagementServer prior to connecting to the specified
Management Server or displaying the login dialog.
After successful authentication with the specified Management Server, authentication should be performed on all child sites in a Milestone Federated Architecture hierarchy.
Deprecated - please use ServerAddress. Specifies, as an integer between 1-65535, the HTTP port of the Management Server. Default is 80.
Note: When using basic authentication and a custom HTTP port on the Management Server, leave this value alone. MIP SDK will automatically use HTTPS on port 443.
Specifies that an HTTPS connection is required for successful authentication.
Note: Requires XProtect VMS versions 2021 R1 and newer.
Deprecated - please use ServerAddress. Specifies the address of the Milestone XProtect VMS Management Server as an IP, hostname, or FQDN.
Specifies the HTTP or HTTPS server address of the Milestone XProtect VMS Management Server.
Show a familiar Milestone login dialog. The dialog supports "Remember password" , and "Auto login".
- Requires an interactive PowerShell session.
Specifies, as an integer value, the maximum number of idle seconds before a Windows Communication Foundation (WCF) channel, used to communicate with Milestone XProtect API's, is considered timed out.
The Configuration API, used directly by commands like
Invoke-Method, and sometimes indirectly by other commands in the
module, uses WCF. There are other API's you can access, such as through the
WCF proxy returned by
Get-IServerCommandService, which also are configured to
use the timeout specified here.
The default setting is suitable for most common usage patterns for this module.
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Connect-ManagementServer does not accept pipeline input.
Unless an error occurs,
Connect-ManagementServer does not generate output.
-ShowDialog, the MIP SDK stores the login history in