Connect-vRNIServer

NAME Connect-vRNIServer



SYNOPSIS

Connects to the specified vRealize Network Insight Platform VM and

constructs a connection object.





SYNTAX

Connect-vRNIServer [-Server] <String> [[-Username] <String>] [[-Password] <String>] [[-Credential] <PSCredential>]

[[-Domain] <String>] [-UseLocalAuth] [<CommonParameters>]





DESCRIPTION

The Connect-vRNIServer cmdlet returns a connection object that contains

an authentication token which the rest of the cmdlets in this module

use to perform authenticated REST API calls.



The connection object contains the authentication token, the expiry

datetime that the token expires and the vRNI server address.





PARAMETERS

-Server <String>

vRNI Platform hostname or IP address



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Username <String>

Username to use to login to vRNI



Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Password <String>

Password to use to login to vRNI



Required? false

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Credential <PSCredential>

PSCredential object containing NSX API authentication credentials



Required? false

Position? 4

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Domain <String>

Domain to use to login to vRNI - Deprecated, use the full username (something@anything.com) for LDAP auth, and

the UseLocalAuth parameter to force local user auth



Required? false

Position? 5

Default value

Accept pipeline input? false

Accept wildcard characters? false



-UseLocalAuth [<SwitchParameter>]

Are we doing local authentication?



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Connect-vRNIServer -Server vrni-platform.lab.local



Connect to vRNI Platform VM with the hostname vrni-platform.lab.local,

the cmdlet will prompt for credentials. Returns the connection object,

if successful.









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Connect-vRNIServer -Server vrni-platform.lab.local -Username admin@local -Password secret



Connect to vRNI Platform VM with the hostname vrni-platform.lab.local

with the given local credentials. Returns the connection object, if successful.









-------------------------- EXAMPLE 3 --------------------------



PS C:\\>Connect-vRNIServer -Server vrni-platform.lab.local -Username martijn@ld.local -Password secret



Connect to vRNI Platform VM with the hostname vrni-platform.lab.local

with the given LDAP credentials. Returns the connection object, if successful.









-------------------------- EXAMPLE 4 --------------------------



PS C:\\>Connect-vRNIServer -Server vrni-platform.lab.local -Username martijn@ld.local -Password secret -UseLocalAuth



Connect to vRNI Platform VM with the hostname vrni-platform.lab.local

with the given LOCAL credentials. Returns the connection object, if successful.









-------------------------- EXAMPLE 5 --------------------------



PS C:\\>$MyConnection = Connect-vRNIServer -Server vrni-platform.lab.local -Username admin@local -Password secret



PS C:\\> Get-vRNIDataSource -Connection $MyConnection

Connects to vRNI with the given credentials and then uses the returned

connection object in the next cmdlet to retrieve all datasources from

that specific vRNI instance.











RELATED LINKS