Set-RAS Cmdlet

Parameters   Output Objects   Config Settings  

The Set-RAS component 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.

Config Settings

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

IgnoreModemSpeakerWhether the component will ignore the default modem speaker settings.
IgnoreSoftwareCompressionWhether the component will ignore the default software compression settings.
OverrideEntrySettingWhether or not to use the component settings when dialing a phone book entry.
PausedStatesWhether the component will accept paused states.
PauseOnScriptTells the component to display a logon terminal.
SetModemSpeakerWhether the component will use the modem speaker.
SetSoftwareCompressionWhether the component will use software compression.
UseCustomScriptingTells the component 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.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

LogFile Parameter (Set-RAS Cmdlet)

The location of a file to which debug information is written.

Syntax

Set-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 (Set-RAS Cmdlet)

Specifies one or more configuration settings.

Syntax

Set-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

Create Property (Set-RAS Cmdlet)

Specifies if the phonebook entry should be created.

Syntax

Set-RAS -Create SwitchParameter

Remarks

The phonebook entry will be created if this parameter is set.

Default Value

false

Delete Property (Set-RAS Cmdlet)

The entry to delete.

Syntax

Set-RAS -Delete SwitchParameter

Remarks

Deleting the entry is irreversible.

Default Value

false

DeviceName Property (Set-RAS Cmdlet)

The device name for the new entry.

Syntax

Set-RAS -DeviceName string

Remarks

When adding a new entry, this parameter specifies the name of the device.

Default Value

""

DNSServer Property (Set-RAS Cmdlet)

The DNS server of the phonebook entry.

Syntax

Set-RAS -DNSServer string

Remarks

The entry is created through the Create switch.

Default Value

""

IPAddress Property (Set-RAS Cmdlet)

The IPAddress of the new entry.

Syntax

Set-RAS -IPAddress string

Remarks

The entry is created through the Create switch.

Default Value

""

LogFile Property (Set-RAS Cmdlet)

The location of a file to which debug information is written.

Syntax

Set-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

""

Name Property (Set-RAS Cmdlet)

The name of the new entry.

Syntax

Set-RAS -Name string

Remarks

The entry is created through the Create switch.

Default Value

""

Parameter Alias

EntryName

Phonebook Property (Set-RAS Cmdlet)

The phonebook for the current operation.

Syntax

Set-RAS -Phonebook string

Remarks

In a Create operation, the phonebook specifies where the entry is created.

Default Value

""

PhoneNumber Property (Set-RAS Cmdlet)

The phone number of the new entry.

Syntax

Set-RAS -PhoneNumber string

Remarks

The entry is created through the Create switch.

Default Value

""

WINSServer Property (Set-RAS Cmdlet)

The WINS server for the entry.

Syntax

Set-RAS -WINSServer string

Remarks

The entry is created through the Create switch.

Default Value

""

CreatedEntry Output Object (Set-RAS Cmdlet)

Represents a created entry.

Syntax

Object CreatedEntry {
   string Entry;
   string PhoneNumber;
   string DNSServer;
   string WINSServer;
   string IPAddress;
   string DeviceName;
}

Remarks

Fields contain information about the entry created.

DeletedEntry Output Object (Set-RAS Cmdlet)

Represents the entry that was deleted.

Syntax

Object DeletedEntry {
   string Entry;
   string Phonebook;
}

Remarks

This is especially useful in the event the entry needs to be added again to the notebook.

Config Settings (Set-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:

0 VPN_DEFAULT
1 VPN_PPTP
2 VPN_L2TP
3 VPN_SSTP

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:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8
The following is a list of valid code page identifiers for Mac OS only:
IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

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:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
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 true.

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:   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 configuration 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 dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file.