Set-RAS Cmdlet
Parameters Output Objects Configuration Settings
The Set-RAS cmdlet can be used to call the Remote Access System (RAS) to create and delete phonebook entries.
Syntax
Set-RAS [parameters]
Remarks
The user can specify a series of properties for adding the phonebook entry, such as Name, PhoneNumber, DNSServer, etc.
Deleting is also supported by providing the Name of the entry and setting the Delete flag.
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.
# create a new phonebook entryset-ras -create -name "NewEntry" -phonenumber "15555551234" -dnsserver "10.0.1.1"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. |
| Create | Specifies if the phonebook entry should be created. |
| Delete | The entry to delete. |
| DeviceName | The device name for the new entry. |
| DNSServer | The DNS server of the phonebook entry. |
| IPAddress | The IPAddress of the new entry. |
| LogFile | The location of a file to which debug information is written. |
| Name | The name of the new entry. |
| Phonebook | The phonebook for the current operation. |
| PhoneNumber | The phone number of the new entry. |
| WINSServer | The WINS server for the entry. |
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.
| CreatedEntry | Represents a created entry. |
| DeletedEntry | Represents the entry that was deleted. |
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 cmdlet will ignore the default modem speaker settings. |
| IgnoreSoftwareCompression | Whether the cmdlet will ignore the default software compression settings. |
| OverrideEntrySetting | Whether or not to use the cmdlet settings when dialing a phone book entry. |
| PausedStates | Whether the cmdlet will accept paused states. |
| PauseOnScript | Tells the cmdlet to display a logon terminal. |
| SetModemSpeaker | Whether the cmdlet will use the modem speaker. |
| SetSoftwareCompression | Whether the cmdlet will use software compression. |
| UseCustomScripting | Tells the cmdlet 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. |
| UseBackgroundThread | Whether threads created by the cmdlet are background threads. |
| UseInternalSecurityAPI | Tells the cmdlet whether or not to use the system security libraries or an internal implementation. |