Connect-SasMetadataServer

NAME
    Connect-SasMetadataServer

SYNOPSIS
    Connect to a Metadata server

SYNTAX
    Connect-SasMetadataServer [-Uri] <String> [-User] <String> [-Password] <PSObject> [<CommonParameters>]

    Connect-SasMetadataServer [-Uri] <String> [-Credential] <PSObject> [<CommonParameters>]

    Connect-SasMetadataServer [-Uri] <String> [<CommonParameters>]

DESCRIPTION

PARAMETERS
    -Uri <String>
        Uri string containing the server definition or the name of a SAS profile.

        For more information about a server definition URI see SAS documentation: http://support.sas.com/docum
        entation/cdl/en/oledbpr/63701/HTML/default/viewer.htm#p016vf6x8ord2nn1pm0dg3fjsuo1.htm

        Required?                    true
        Position?                    0
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

    -User <String>
        Username

        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

    -Password <PSObject>
        Password as plain text
        or as a SecureString object

        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

    -Credential <PSObject>
        One of two types of supported credentials object:
        1) PsCredential object.
        Create object from interactive prompt with the Get-Credential Cmdlet
        2) SASObjectManager.LoginDef object.
        The SAS API may provide you a LoginDef object or you can create new LoginDef COM objects with the 
        New-Object Cmdlet.

        Required?                    true
        Position?                    1
        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 (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES

    --------------  Example 1  --------------

    PS C:\> # remote server with IWA
    $omi = Connect-SasMetadataServer "iom://mycompany.com:8561;Bridge;SECURITYPACKAGE=Negotiate"

    Creates a metadata server session on a remote server using Integrated Windows Authentication (IWA)

    --------------  Example 2  --------------

    PS C:\> # remote server with username and password
    $omi = Connect-SasMetadataServer "iom://mycompany.com:8561;Bridge" "MyUser" "MyPassword"

    Creates a metadata server session on a remote server using explicit username and password

    --------------  Example 3  --------------

    PS C:\> # remote server with username and password
    $User = Read-Host -Prompt 'Enter User'
    $SecurePassword = Read-Host -Prompt 'Enter password' -AsSecureString
    $omi = Connect-SasMetadataServer "iom://mycompany.com:8561;Bridge" $User $Password

    Creates a metadata server session on a remote server using username and secured password

    --------------  Example 4  --------------

    PS C:\> # remote server with credentials
    $myCreds = Get-Credential
    $omi = Connect-SasMetadataServer "iom://mycompany.com:8561;Bridge" $myCreds

    Creates a metadata server session on a remote server using credentials from prompt

    --------------  Example 5  --------------

    PS C:\> # remote server with credentials
    $objLogin = New-Object -ComObject SASObjectManager.LoginDef;
    $objLogin.LoginName = "MyUser";
    $objLogin.Password = "MyPass";

    $omi = Connect-SasMetadataServer "iom://mycompany.com:8561;Bridge" $objLogin

    Creates a metadata server session on a remote server using credentials from LoginDef object

    --------------  Example 6  --------------

    PS C:\> $omi = Connect-SasMetadataServer "My Server"

    Creates a metadata server session on a remote server using server definition and credentials from an 
    existing SAS profile. You can get a list of available profiles with the Get-SasLocalProfiles cmdlet.

RELATED LINKS