Connect-MceSession

SYNOPSIS#

Connects the MCE module to an administration session.

SYNTAX#

Connect-MceSession [-ServerAddress] <String> [[-Credential] <PSCredential>] [<CommonParameters>]

DESCRIPTION#

This cmdlet initializes the connection to an MCE Administration Services server.

This cmdlet must be invoked before any other cmdlet in the module.

EXAMPLES#

EXAMPLE 1#

Connect-MceSession -ServerAddress mce.company.com

Connects the module to the MCE Administration Services running at https://mce.company.com.

EXAMPLE 2#

$Cred = Get-Credential -Credential superuser
Connect-MceSession -ServerAddress https://mce.company.com:8080/administration -Credential $Cred

Connects the module to the MCE Administration Services running at https://mce.company.com:8080/administration with credentials.

PARAMETERS#

-ServerAddress#

The server address.

Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Credential#

The credential.

Type: PSCredential
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

CommonParameters#

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS#

System.String#

The server address.

System.Management.Automation.PSCredential#

The credential.

OUTPUTS#

MindLink.Core.Mce.PowerShell.Services.MceSessionConnectionResult#

The MCE session connection result.

NOTES#

RELATED LINKS#

MindLink Docs