Connect to a UC Commander server for the purposes of using other cmdlets from the /wiki/spaces/PS/overview.
Item | Comment |
---|---|
Availability version | Version 1.0 |
Initial release date | |
Last updated on | June 27, 2017 |
Related to | Enterprise Commander Documentation |
Role required | For a complete list of User Roles, see User Roles. |
Aliases | Connect-DossierServer |
Syntax
Connect-UdmServer [-Identity] <String> [-Credentials <PSCredential>] [-Username <String>] [-Password <String>] [<CommonParameters>]
Parameters
Parameter | Description | Class | Accepted options | Constraints | Usage | Unique | Available from version |
---|---|---|---|---|---|---|---|
Identity | Indicates the identity of the UC Commander server to connect to. | System.String | Should begin with https:// or http://. If neither is specified, it will default to https://. | Required | Changed from "server" in version 1.5.00.0 | ||
Credentials | Enables you to run this cmdlet under alternate credentials. To use the Credential parameter you must first create a PSCredential object by using the Get-Credential cmdlet. For more information on using the Get-Credential cmdlet, see https://technet.microsoft.com/en-us/library/hh849815.aspx. | System.Management.Automation.PSCredential | Cannot be used if -Username and/or -Password are specified. | Optional | v1.0 | ||
Username | Username of login to run cmdlet. User must be assigned the role listed above. | System.String | Cannot be used if -Credentials is specified. Must be used in conjunction with -Password. | Optional | v1.0 | ||
Password | Password of the above user to run cmdlet. | System.String | Cannot be used if -Credentials is specified. Must be used in conjunction with -Username. | Optional | v1.0 |
Examples
Example 1
In example 1, the Connect-UccServer cmdlet connects to the UC Commander server ghost.eventzero.net using the username "testuser" and password "test_password".
Connect-UccServer -Identity https://contoso.eventzero.net -Username testuser -Password test_password
Example 2
In example 2, the connection is made to the same UC Commander server as example 1, but uses credentials from Get-Credential instead of from -Username and -Password.
$cred = Get-Credential Connect-UccServer -Identity https://contoso.eventzero.net -Credentials $cred
See Also
Cmdlet | Description |
---|---|
/wiki/spaces/PS/pages/73465870 | Retrieves the UC Commander server that all cmdlets will be sent to. |