Connect-UxGateway

NAME Connect-UxGateway



SYNOPSIS

This cmdlet connects to the Ribbon SBC and extracts the session token and places it into a custom PS Object called

uxSession





SYNTAX

Connect-UxGateway [-uxhostname] <String> [-Credentials] <PSCredential> [<CommonParameters>]





DESCRIPTION

This cmdlet connects to the Ribbon SBC and extracts the session token required for subsequent cmdlets.

All other cmdlets will fail if this command is not successfully executed.





PARAMETERS

-uxhostname <String>

Enter here the hostname or IP address of the Ribbon SBC



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Credentials <PSCredential>

Pass a secure credential to the cmdlet, this should be your REST API credentials.



Required? true

Position? 2

Default value

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:\\>$Creds = Get-credential



connect-uxgateway -uxhostname 1.1.1.1 -Credentials $Creds









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



PS C:\\>$Creds = Get-credential



connect-uxgateway -uxhostname lyncsbc01.COMPANY.co.uk -Credentials $Creds









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



PS C:\\>$Creds = Get-credential



$Session1 = connect-uxgateway -uxhostname lyncsbc01.COMPANY.co.uk -Credentials $Creds

$Session2 = connect-uxgateway -uxhostname lyncsbc02.COMPANY.co.uk -Credentials $Creds











RELATED LINKS