NetCmdlets 2016
NetCmdlets 2016
Questions / Feedback?

Get-RAS Cmdlet

Parameters   Output Objects   Configuration Settings  

The Get-RAS cmdlet 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.

LogFileThe location of a file to which debug information is written.
ConfigSpecifies one or more configuration settings.
ListConnectionsList all current connections.
ListDevicesList all dial devices.
ListPhonebookList all entries in Phonebook .
LogFileThe location of a file to which debug information is written.
PhonebookThe 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.

ConnectionRepresents every connected device.
DeviceRepresents every dial device.
EntryFired for every Phonebook entry.

Configuration Settings


The following is a list of configuration settings for the cmdlet with short descriptions. Click on the links for further details.

IgnoreModemSpeakerWhether the cmdlet will ignore the default modem speaker settings.
IgnoreSoftwareCompressionWhether the cmdlet will ignore the default software compression settings.
OverrideEntrySettingWhether or not to use the cmdlet settings when dialing a phone book entry.
PausedStatesWhether the cmdlet will accept paused states.
PauseOnScriptTells the cmdlet to display a logon terminal.
SetModemSpeakerWhether the cmdlet will use the modem speaker.
SetSoftwareCompressionWhether the cmdlet will use software compression.
UseCustomScriptingTells the cmdlet to use custom script DLLs.
UsePrefixSuffixWhether or not to use the dialing prefix and suffix in the phone book.
UseRemoteDefaultGatewayWhether or not the entry should use the default gateway on the remote network.
VPNTypeSets the VPN Type when creating entries with NetDial.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
NetCmdlets 2016 - Version 16.0 [Build 6335]