Recent changes to Connect-SasMetadataServer

Connect-SasMetadataServer modified by Andreas Menrath

Andreas Menrath — Mon, 14 Jul 2014 14:54:23 -0000

Connect-SasMetadataServer modified by Andreas Menrath

Andreas Menrath — Mon, 14 Jul 2014 14:44:43 -0000

--- v2
+++ v3
@@ -1,97 +1,129 @@
-    Synopsis
+    NAME
+        Connect-SasMetadataServer
+        
+    SYNOPSIS
         Connect to a Metadata server
-    
-    Syntax
+        
+    SYNTAX
         Connect-SasMetadataServer [-Uri] <String> [-User] <String> [-Password] <PSObject> [<CommonParameters>]
-    
+        
         Connect-SasMetadataServer [-Uri] <String> [-Credential] <PSObject> [<CommonParameters>]
-    
+        
         Connect-SasMetadataServer [-Uri] <String> [<CommonParameters>]
-    
-    
-    Description
+        
+        
+    DESCRIPTION
+

-    
-    Parameters
+    PARAMETERS
         -Uri <String>
-            Uri string containing the server definition.
-            For more information see SAS documentation: http://support.sas.com/documentation/cdl/en/oledbpr/63701/HTML/default/viewer.htm#p016vf6x8ord2nn1pm0dg3fjsuo1.htm
-    
+            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.
-    
+            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
-    
-    
-    
-    Inputs
+            
+        <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). 

-    
-    Outputs
+    INPUTS

-    
-    Notes
+            
+            

-    
-    Examples
+         
+        
+    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";
@@ -99,4 +131,17 @@

         $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
+

Connect-SasMetadataServer modified by Andreas Menrath

Andreas Menrath — Sun, 12 Jan 2014 20:42:05 -0000

Connect-SasMetadataServer modified by Andreas Menrath

Andreas Menrath — Sun, 20 Oct 2013 12:05:49 -0000

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.
        For more information see SAS documentation: http://support.sas.com/documentation/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

Inputs

Outputs

Notes

Examples
    --------------  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