Connect to a UC Commander Ranger server for the purposes of using other cmdlets from the /wiki/spaces/PS/overview Ranger PowerShell module.
| Item | Comment |
|---|
| Availability version | Version 1.0 |
| Initial release date | June 27, 2017 |
| Last updated on | June 27, 2017 |
| Related to | entcomdoc |
| Role required | For a complete list of User Roles, see User Roles. |
| Aliases | Connect-DossierServer |
| Ranger Documentation |
Syntax
| Code Block |
|---|
|
Connect-UdmServer [-Identity]Tenant <String> [-Credentials <PSCredential>] [-Username <String>] [-Password <String>] [<CommonParameters>] |
Parameters
| Parameter | Description | Class | Accepted options | Constraints | Usage | Unique | Available from version |
|---|
| IdentityTenant | Indicates the FQDN identity of the UC Commander Ranger 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.00If not specified a EzUdmTenants.xml file is searched for before prompting for the tenant name | Optional | | v1.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 UdmServer cmdlet connects to the UC Commander server ghostthe Ranger server contoso.udm.eventzero.net using the username "testuser" and password "test_password".and you are prompted to enter credentials
| Code Block |
|---|
|
Connect-UccServerUdmServer -Identitytenant https://contoso.udm.eventzero.net -Username testuser -Password test_password |
Example 2
In example 2, the connection is made to the same UC Commander Ranger server as example 1, but uses credentials from Get-Credential instead of from -Username and -Password. Credential
| Code Block |
|---|
|
$cred = Get-Credential
Connect-UccServerUdmServer -Identitytenant https://contoso.udm.eventzero.net -Credentials $cred |
See Also
...
...