Get-RAS Cmdlet
Parameters Output Objects Configuration 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. |
Configuration Settings
The following is a list of configuration 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. |
UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |