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 entry
set-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.

LogFileThe location of a file to which debug information is written.
ConfigSpecifies one or more configuration settings.
CreateSpecifies if the phonebook entry should be created.
DeleteThe entry to delete.
DeviceNameThe device name for the new entry.
DNSServerThe DNS server of the phonebook entry.
IPAddressThe IPAddress of the new entry.
LogFileThe location of a file to which debug information is written.
NameThe name of the new entry.
PhonebookThe phonebook for the current operation.
PhoneNumberThe phone number of the new entry.
WINSServerThe 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.

CreatedEntryRepresents a created entry.
DeletedEntryRepresents 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.

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.
UseInternalSecurityAPITells the cmdlet whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
NetCmdlets 2020 - Version 20.0 [Build 7877]