Connect to a Ranger server for the purposes of using other cmdlets from the Ranger PowerShell module.
| Item | Comment |
|---|
| Availability version | Version 1.0 |
| Initial release date | June 27, 2017 |
| Last updated on | June 27, 2017 |
| Related to | Ranger Documentation |
Syntax
| Code Block |
|---|
|
Connect-UdmServer -Tenant <String> [-Credentials <PSCredential>] [<CommonParameters>] |
Parameters
| Parameter | Description | Class | Accepted options | Constraints | Usage | Unique | Available from version |
|---|
| Tenant | Indicates the FQDN identity of the Ranger server to connect to. | System.String | | If 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 | |
| Optional | | v1.0 |
Examples
Example 1
In example 1, the Connect-UdmServer cmdlet connects to the Ranger server contoso.udm.eventzero.net and you are prompted to enter credentials
| Code Block |
|---|
|
Connect-UdmServer -tenant contoso.udm.eventzero.net |
Example 2
In example 2, the connection is made to the same Ranger server as example 1, but uses credentials from Get-Credential
| Code Block |
|---|
|
$cred = Get-Credential
Connect-UdmServer -tenant contoso.udm.eventzero.net -Credentials $cred |
See Also