Get-RAS Cmdlet
Parameters Output Objects Config Settings
The Get-RAS component can be used to call the Remote Access System (RAS) to list connections, devices and phonebook entries.
Syntax
Get-RAS [parameters]
Remarks
To retrieve a list of all connections in all devices, set the ListConnections switch to retrieve zero or more Connections.
To retrieve a list of the dial devices on the system, you can set the ListDevices switch to retrieve zero or more Devices.
For a list of phonebook entries, set the ListPhonebook switch to return zero or more Entrys. If more than one phonebook is available, you can specify the phonebook in the Phonebook parameter.
Support is also provided for creating and/or deleting phonebook entries. To do this, set the SET-RAS cmdlet.
The cmdlets support pipeline input for some of their parameters. Prebuilding an object and piping it to the cmdlet is very useful, but should be used with caution to prevent security conflicts. Steps have been taken to decrease the risk of a possibly accidental pipe to the cmdlet, for instance, the Credential parameter cannot be piped to the cmdlet and must be specified manually.
# list devices
get-ras -listdevices
# list connections
get-ras -listconnections
# list entries in the phonebook "My Phonebook"
get-ras -listphonebook -phonebook "My Phonebook"
Parameter List
The following is the full list of the parameters of the cmdlet with short descriptions. Click on the links for further details.
| LogFile | The location of a file to which debug information is written. |
| Config | Specifies one or more configuration settings. |
| ListConnections | List all current connections. |
| ListDevices | List all dial devices. |
| ListPhonebook | List all entries in Phonebook . |
| LogFile | The location of a file to which debug information is written. |
| Phonebook | The phonebook to use for the operation. |
Output Objects
The following is the full list of the output objects returned by the cmdlet with short descriptions. Click on the links for further details.
| Connection | Represents every connected device. |
| Device | Represents every dial device. |
| Entry | Fired for every Phonebook entry. |
Config Settings
The following is a list of config settings for the cmdlet with short descriptions. Click on the links for further details.
| IgnoreModemSpeaker | Whether the component will ignore the default modem speaker settings. |
| IgnoreSoftwareCompression | Whether the component will ignore the default software compression settings. |
| OverrideEntrySetting | Whether or not to use the component settings when dialing a phone book entry. |
| PausedStates | Whether the component will accept paused states. |
| PauseOnScript | Tells the component to display a logon terminal. |
| SetModemSpeaker | Whether the component will use the modem speaker. |
| SetSoftwareCompression | Whether the component will use software compression. |
| UseCustomScripting | Tells the component to use custom script DLLs. |
| UsePrefixSuffix | Whether or not to use the dialing prefix and suffix in the phone book. |
| UseRemoteDefaultGateway | Whether or not the entry should use the default gateway on the remote network. |
| VPNType | Sets the VPN Type when creating entries with NetDial. |
| BuildInfo | Information about the product's build. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| LicenseInfo | Information about the current license. |
| MaskSensitive | Whether sensitive data is masked in log messages. |
| UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |
LogFile Parameter (Get-RAS Cmdlet)
The location of a file to which debug information is written.
Syntax
Get-RAS -LogFile string
Remarks
When specified, the cmdlet will log debug information to the file. If the file exists, the information will be appended.Default Value
null
Config Property (Get-RAS Cmdlet)
Specifies one or more configuration settings.
Syntax
Get-RAS -Config string[]
Remarks
The Config parameter takes one or more name-value pairs that represent the name of the configuration setting and value, i.e.: -config "Name=Value"
Default Value
null
ListConnections Property (Get-RAS Cmdlet)
List all current connections.
Syntax
Get-RAS -ListConnections SwitchParameter
Remarks
A flag to trigger the listing of all connections in all devices and output the results in Entry objects.
Default Value
false
ListDevices Property (Get-RAS Cmdlet)
List all dial devices.
Syntax
Get-RAS -ListDevices SwitchParameter
Remarks
A flag to trigger the listing of all dial devices. The output is reported through a series of Device objects.
Default Value
false
ListPhonebook Property (Get-RAS Cmdlet)
List all entries in Phonebook .
Syntax
Get-RAS -ListPhonebook SwitchParameter
Remarks
List all entries in Phonebook (Windows 95 has only one default Phonebook). Entries are given through Entry objects.
Default Value
false
LogFile Property (Get-RAS Cmdlet)
The location of a file to which debug information is written.
Syntax
Get-RAS -LogFile string
Remarks
When specified, the cmdlet will log debug information to the file. If the file exists, the information will be appended.
Default Value
""
Phonebook Property (Get-RAS Cmdlet)
The phonebook to use for the operation.
Syntax
Get-RAS -Phonebook string
Remarks
This parameter is valuable only in Windows NT 4.0 and higher where multiple phonebooks can be specified. If it is empty the default phonebook is used.
Default Value
""
Connection Output Object (Get-RAS Cmdlet)
Represents every connected device.
Syntax
Object Connection {long Handle;
string Entry;
string DeviceName;
string DeviceType;
string StatusDescription;
}
Remarks
The Handle parameter can be used to disconnect the entry. You should assign Handle to the Handle parameter of the set-RAS cmdlet when using the disconnect flag.
Device Output Object (Get-RAS Cmdlet)
Represents every dial device.
Syntax
Object Device {string Name;
string Type;
}
Remarks
Name provides the name of the device, and Type provides the corresponding device type (e.g. 'modem').
Entry Output Object (Get-RAS Cmdlet)
Fired for every Phonebook entry.
Syntax
Object Entry {string Entry;
}
Remarks
If Phonebook is not set, the entries are part of the default phonebook.
Config Settings (Get-RAS Cmdlet)
The cmdlet accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the cmdlet, access to these internal properties is provided through the Config method.NetDial Config Settings
| IgnoreModemSpeaker: Whether the cmdlet will ignore the default modem speaker settings.Setting this value to True will cause the cmdlet to ignore the modem speaker settings in the Remote Access System (RAS) phonebook, and it will use the setting specified by SetModemSpeaker. If it is False, the cmdlet uses the modem speaker setting that is in the RAS phonebook, and it then ignores the setting specified by the SetModemSpeaker. | |||||||||
| IgnoreSoftwareCompression: Whether the cmdlet will ignore the default software compression settings.If this is value is set to True, the cmdlet ignores the software compression setting that is in the RAS phonebook, and it uses the setting specified by SetSoftwareCompression. If it is set to False, the cmdlet uses the software compression setting that is in the RAS phonebook, and it then ignores the setting specified by SetSoftwareCompression. | |||||||||
| OverrideEntrySetting: Whether or not to use the cmdlet settings when dialing a phone book entry.If this is value is set to True, the cmdlet will use PhoneNumber, CallBackNumber, User, Password, and Domain as specified in the cmdlet, instead of the value specified in the preexisting phonebook entry. | |||||||||
| PausedStates: Whether the cmdlet will accept paused states.If this is value is set to True, the cmdlet will accept paused states. Paused states include terminal mode, retry logon, change password, set callback number, and EAP authentication. If it is set to False, the cmdlet will report a fatal error if it enters a paused state. | |||||||||
| PauseOnScript: Tells the cmdlet to display a logon terminal.This value is used internally by the system for Windows-95-style logon script execution. If this is value is set to True, a logon script will be displayed in a terminal window visible to the user. Applications should not set this value. | |||||||||
| SetModemSpeaker: Whether the cmdlet will use the modem speaker.This configuration value determines whether or not the modem speaker will sound during a connection. If IgnoreModemSpeaker is False, the cmdlet ignores the value of SetModemSpeaker, and it sets the modem speaker based on the RAS phonebook setting or the default setting. | |||||||||
| SetSoftwareCompression: Whether the cmdlet will use software compression.This configuration value determines whether or not the cmdlet uses software compression for the modem connection. If IgnoreSoftwareCompression is False, the cmdlet ignores the value of SetSoftwareCompression, and it sets the software compression state based on the RAS phonebook setting or the default setting. | |||||||||
| UseCustomScripting: Tells the cmdlet to use custom script DLLs.This configuration setting specifies that the cmdlet should invoke a custom-scripting DLL (dynamic link library) after establishing the connection to the server. The cmdlet can invoke the DLL only if all of the following conditions are met: UseCustomScripting is specifically set to True. A custom-scripting DLL is correctly registered with the system. The CustomScript option is specified in the phonebook entry. Note: This option is not supported in Windows 2000 and NT. | |||||||||
| UsePrefixSuffix: Whether or not to use the dialing prefix and suffix in the phone book.If this is value is set to True, the cmdlet will use the prefix and suffix that are stored in the RAS phonebook. If it is False, the cmdlet will ignore the prefix and suffix. | |||||||||
| UseRemoteDefaultGateway:
Whether or not the entry should use the default gateway on the remote network.UseRemoteDefaultGateway is used when creating a new entry. By default, this
value is True, and it tells the entry created that it should forward data that cannot be sent
on the local network to the dial-up connection.
Note: This option is valid only when a local area network connection and dial-up connection both exist simultaneously. |
|||||||||
VPNType:
Sets the VPN Type when creating entries with NetDial.The supported values include the following:
Note: This configuration setting is available only in .NET. |
Base Config Settings
| BuildInfo: Information about the product's build.When queried, this setting will return a string containing information about the product's build. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CodePage:
The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).
The following is a list of valid code page identifiers:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LicenseInfo:
Information about the current license.When queried, this setting will return a string containing information about the license this instance of a cmdlet is using. It will return the following information:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MaskSensitive:
Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is false.
This setting only works on these cmdlets: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| UseInternalSecurityAPI:
Tells the cmdlet whether or not to use the system security libraries or an internal implementation.
When set to false, the cmdlet will use the system security libraries by default to perform cryptographic functions where applicable.
In this case, calls to unmanaged code will be made. In certain environments this is not desirable.
To use a completely managed security implementation set this setting to true.
Setting this setting to true tells the cmdlet to use the internal implementation instead of using the system security libraries. On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default. If using the .NET Standard Library, this setting will be true on all platforms. The .NET Standard library does not support using the system security libraries. Note: This setting is static. The value set is applicable to all cmdlets used in the application. When this value is set the product's system DLL is no longer required as a reference, as all unmanaged code is stored in that file. |