configuration

getServOpt

Description

displays the value of a server option.

configuration.getServOpt <result=results> <status=rc> / name="ADDNODECANCELTIMEOUT" | "ADDNODEKILLTIMEOUT" | "APPTAG" | "AZUREAUTHCACHELOC" | "AZURETENANTID" | "BIGINT" | "BIGINTPROCESSING" | "CASLIB" | "CFG" | "CFGNAME" | "CFGPATH" | "CMPLIB" | "CMPOPT" | "COLLATE" | "CONTROLPID" | "CPUSHARES" | "DATASTEPFMTERR" | "DATASTEPMERGENOBY" | "DATASTEPMSGSUMLEVEL" | "DATASTEPREPLACETABLE" | "DATASTEPVARLENCHK" | "DATESTYLE" | "DCEXTPORT" | "DCHOSTNAMERESOLUTION" | "DCPORT" | "DCSSLCERTISS" | "DCSSLCERTLOC" | "DCSSLCERTSERIAL" | "DCSSLCERTSUBJ" | "DCSSLPKCS12LOC" | "DCSSLPKCS12PASS" | "DCSSLPVTKEYLOC" | "DCSSLPVTKEYPASS" | "DCSSLPVTKEYPASSLOC" | "DCTCPMENCRYPT" | "DCTCPMENCRYPTALGORITHM" | "DEBUGOPT" | "DEFAULTMEMORYFORMAT" | "DEFAULTREP" | "DEFAULTTABLEREPLICATION" | "DQLOCALE" | "DQQKBREPOLOC" | "DQSETUPLOC" | "ELASTIC" | "ENCRYPTFIPS" | "EVENTDS" | "EXECUTABLE" | "EXTHOSTKNOWNBY" | "FMTERR" | "FMTSEARCH" | "GCPORT" | "HISTORYLINELENGTH" | "HOSTKNOWNBY" | "HTTPPORT" | "HTTPPORTMAX" | "ID" | "INITIALBACKUPS" | "INITIALWORKERS" | "INSTALL" | "INTERVALDS" | "JOIN" | "JREOPTIONS" | "KEYFILE" | "LIFETIME" | "LOCALE" | "LOGFLUSHTIME" | "LOGCFGLOC" | "MACHINELIST" | "MAXSESSIONTRANSFERSIZE" | "MAXTABLEMEM" | "MAXCORES" | "MAXCORESPERWORKER" | "MAXSESSIONS" | "MEMORYSIZE" | "MESSAGELEVEL" | "METRICS" | "NWORKERS" | "NEXTSERVERINSTANCE" | "NLDECSEPARATOR" | "NODE" | "OAUTHSIGNINGCERTIFICATE" | "OAUTHSIGNINGKEY" | "PERMSTORE" | "PORT" | "PREVSERVERINSTANCE" | "PRIVACYSTATEMENT" | "PROVLIST" | "REMOVENODECANCELTIMEOUT" | "REMOVENODEKILLTIMEOUT" | "RESOLVEWORKERADDRESS" | "S2FORMATSEARCH" | "SCALEDOWNMODE" | "SERVICESBASEURL" | "SESSION" | "STARTUP" | "STARTUPDIR" | "STATETRANSFERMODEL" | "SUBSETSESSIONCOPIES" | "TAG" | "TENANTID" | "TIMEZONE" | "TIMEOUT" | "TRANSFERDIR" | "TRANSFERSESSION" | "TRANSFERINTERRUPTTIMEOUT" | "TRANSFERKILLTIMEOUT" | "USEGPU" | "USERLOC" | "USEYARN" | "YEARCUTOFF";
Settings
ParameterDescription
namespecifies the name of a session option to display. Required parameter. Options are: "ADDNODECANCELTIMEOUT", "ADDNODEKILLTIMEOUT", "APPTAG", "AZUREAUTHCACHELOC", "AZURETENANTID", "BIGINT", "BIGINTPROCESSING", "CASLIB", "CFG", "CFGNAME", "CFGPATH", "CMPLIB", "CMPOPT", "COLLATE", "CONTROLPID", "CPUSHARES", "DATASTEPFMTERR", "DATASTEPMERGENOBY", "DATASTEPMSGSUMLEVEL", "DATASTEPREPLACETABLE", "DATASTEPVARLENCHK", "DATESTYLE", "DCEXTPORT", "DCHOSTNAMERESOLUTION", "DCPORT", "DCSSLCERTISS", "DCSSLCERTLOC", "DCSSLCERTSERIAL", "DCSSLCERTSUBJ", "DCSSLPKCS12LOC", "DCSSLPKCS12PASS", "DCSSLPVTKEYLOC", "DCSSLPVTKEYPASS", "DCSSLPVTKEYPASSLOC", "DCTCPMENCRYPT", "DCTCPMENCRYPTALGORITHM", "DEBUGOPT", "DEFAULTMEMORYFORMAT", "DEFAULTREP", "DEFAULTTABLEREPLICATION", "DQLOCALE", "DQQKBREPOLOC", "DQSETUPLOC", "ELASTIC", "ENCRYPTFIPS", "EVENTDS", "EXECUTABLE", "EXTHOSTKNOWNBY", "FMTERR", "FMTSEARCH", "GCPORT", "HISTORYLINELENGTH", "HOSTKNOWNBY", "HTTPPORT", "HTTPPORTMAX", "ID", "INITIALBACKUPS", "INITIALWORKERS", "INSTALL", "INTERVALDS", "JOIN", "JREOPTIONS", "KEYFILE", "LIFETIME", "LOCALE", "LOGFLUSHTIME", "LOGCFGLOC", "MACHINELIST", "MAXSESSIONTRANSFERSIZE", "MAXTABLEMEM", "MAXCORES", "MAXCORESPERWORKER", "MAXSESSIONS", "MEMORYSIZE", "MESSAGELEVEL", "METRICS", "NWORKERS", "NEXTSERVERINSTANCE", "NLDECSEPARATOR", "NODE", "OAUTHSIGNINGCERTIFICATE", "OAUTHSIGNINGKEY", "PERMSTORE", "PORT", "PREVSERVERINSTANCE", "PRIVACYSTATEMENT", "PROVLIST", "REMOVENODECANCELTIMEOUT", "REMOVENODEKILLTIMEOUT", "RESOLVEWORKERADDRESS", "S2FORMATSEARCH", "SCALEDOWNMODE", "SERVICESBASEURL", "SESSION", "STARTUP", "STARTUPDIR", "STATETRANSFERMODEL", "SUBSETSESSIONCOPIES", "TAG", "TENANTID", "TIMEZONE", "TIMEOUT", "TRANSFERDIR", "TRANSFERSESSION", "TRANSFERINTERRUPTTIMEOUT", "TRANSFERKILLTIMEOUT", "USEGPU", "USERLOC", "USEYARN", "YEARCUTOFF".
ADDNODECANCELTIMEOUTspecifies the time to wait, in seconds, before running actions are canceled. Canceling the actions can facilitate the timely completion of an addNode action. Specify 0 to indicate that actions are never canceled.
ADDNODEKILLTIMEOUTspecifies the time to wait, in seconds, before session processes to are killed. Killing the sessions can facilitate the timely completion of a addNode action. Specify 0 to indicate that sessions are never killed. The time-out begins when the addNodeCancelTimeout expires.
APPTAGspecifies a string that is included in the appTag property of CAS Server action log messages.
AZUREAUTHCACHELOCspecifies the path to the cache for Azure storage authorization.
AZURETENANTIDspecifies the tenant ID for Azure storage.
BIGINTNew 64-bit integer processing
BIGINTPROCESSINGNew 64-bit integer processing
CASLIBspecifies the caslib name to set as the active caslib.
CFGThe server configuration file
CFGNAMEThe CAS server configuration name
CFGPATHCAS Server config install location
CMPLIBspecifies one or more SAS data sets that contain compiler subroutines to include during compilation.
CMPOPTspecifies code generation optimizations.
COLLATEspecifies the collating sequence for sorting.
CONTROLPIDThe Process Identifier of the server that launched this instance
CPUSHARESspecifies the shares for the CPU CGroup created for the server.
DATASTEPFMTERRwhen set to True, the DATA step generates an error when a variable format cannot be found. You can set this parameter to False to continue processing instead of generating an error.
DATASTEPMERGENOBYwhen a DATA step merge is run with no BY statement, this parameter determines whether no warning, a warning, or an error message is generated.
DATASTEPMSGSUMLEVELspecifies the DATA step message summary level. When the DATA step runs on multiple threads, the same message can be generated on each thread. This parameter controls the summary level of duplicate messages.
DATASTEPREPLACETABLEspecifies whether DATA step can replace an existing table.
DATASTEPVARLENCHKwhen using APPEND, if the source has longer strings than the destination, this parameter determines whether no warning, a warning, or an error message is generated.
DATESTYLESpecifies the sequence of month, day, and year when ANYDTDTE, ANYDTDTM, or ANYDTTME informat data is ambiguous.
DCEXTPORTspecifies the port number that an external data provider, such as SAS Embedded Process, can use to connect to this node. A value of 0 indicates that the data provider should use the actual port number that CAS is using to listen for connections. A non-zero value might be required in some cloud-based configurations.
DCHOSTNAMERESOLUTIONspecifies the host name for the SAS Embedded Process.
DCPORTspecifies the port number that CAS can use to listen for connections from an external data provider. A value of -1 indicates that data connectors should share the port specified for GCPORT. A value of 0 indicates that data connectors should use an ephemeral port.
DCSSLCERTISSspecifies the name of the issuer of the digital certificate that TLS should use.
DCSSLCERTLOCspecifies the location of the digital certificate for the machine's public key. This is used for authentication.
DCSSLCERTSERIALspecifies the serial number of the digital certificate that TLS uses.
DCSSLCERTSUBJspecifies the subject name of the digital certificate that TLS uses.
DCSSLPKCS12LOCspecifies the location of the PKCS #12 encoding package file.
DCSSLPKCS12PASSspecifies the password that TLS requires for decrypting the private key.
DCSSLPVTKEYLOCspecifies the location of the private key corresponding to the digital certificate.
DCSSLPVTKEYPASSspecifies the password that TLS requires for decrypting the private key.
DCSSLPVTKEYPASSLOCspecifies the file containing the password that TLS requires for decrypting the private key.
DCTCPMENCRYPTspecifies use of encryption for the communication partner.
DCTCPMENCRYPTALGORITHMspecifies the encryption algorithm to use.
DEBUGOPTDebugger options
DEFAULTMEMORYFORMATspecifies the default memory format for session tables.
DEFAULTREPDefault new table replication factor
DEFAULTTABLEREPLICATIONDefault new table replication factor
DQLOCALEspecifies the default locale to use for data quality operations. Use a 5-letter locale code.
DQQKBREPOLOCspecifies the name of the caslib where QKBs are stored.
DQSETUPLOCspecifies the name of the default QKB to use for data quality operations.
ELASTICThe server option to provide run-time grid expansion; requires 'keyfile' option
ENCRYPTFIPSuse only FIPS 140-2 compliant algorithms.
EVENTDSspecifies one or more event objects that define custom date events.
EXECUTABLEspecifies the server session executable name.
EXTHOSTKNOWNBYspecifies the host name that external data providers should use to connect to this node. This value might need to be set in some cloud configurations.
FMTERRwhen set to True, the DATA step generates an error when a variable format cannot be found. You can set this parameter to False to continue processing instead of generating an error.
FMTSEARCHspecifies the format search list to set during start-up of a session.
GCPORTspecifies the port number for inter-node communication on a distributed server.
HISTORYLINELENGTHspecifies the maximum history line length.
HOSTKNOWNBYspecifies the DNS name that other nodes should use to connect to this machine.
HTTPPORTspecifies the port number for the HTTP interface to the server.
HTTPPORTMAXspecifies the maximum port range value for the HTTP interface port.
IDspecifies the server rank that is assigned at run-time.
INITIALBACKUPSspecifies the minimum number of backup controllers that must connect before the server accepts client requests.
INITIALWORKERSspecifies the minimum number of workers that must connect before the server accepts client requests.
INSTALLspecifies the server installation path.
INTERVALDSspecifies interval object pairs.
JOINspecifies the name of the server to join, from the JOIN command.
JREOPTIONSspecifies the JRE options.
KEYFILEspecifies the full path to the key file.
LIFETIMEspecifies the server lifetime, in minutes. A value of 0 indicates that the server runs indefinitely.
LOCALEspecifies the locale to use for sorting and formatting.
LOGFLUSHTIMEspecifies the log flush time, in milliseconds. A value of -1 indicates to flush logs after each action completes. A value of 0 indicates to flush logs as they are produced.
LOGCFGLOCspecifies the full path to the log configuration file.
MACHINELISTspecifies the full path to file on the controller host that lists the machines in the distributed server.
MAXSESSIONTRANSFERSIZEMaximum amount of session local data for sessions to transfer to new server.
MAXTABLEMEMspecifies the maximum amount of memory, in bytes, that each thread should allocate for in-memory blocks before converting to a memory-mapped file. Files are written in the directories that are specified in the CAS_DISK_CACHE environment variable. When you create a large output table, such as 5G or more for each worker, you can set this value to 256M or more to improve performance.
MAXCORESspecifies the maximum number of cores available. The lesser of the specified value and the number of cores specified in the product license will be used.
MAXCORESPERWORKERspecifies the maximum cores per worker.
MAXSESSIONSspecifies the maximum number of concurrent sessions. Users who can assume an administrative role are not subject to the limit.
MEMORYSIZEspecifies the memory limit, in bytes, for a CGroup and YARN request.
MESSAGELEVELspecifies the log message level.
METRICSwhen set to True, action metrics are displayed.
NWORKERSspecifies the number of worker nodes associated with this session.
NEXTSERVERINSTANCEPod name of next server instance
NLDECSEPARATORWhen set to True, enables numeric output to format using the decimal separator for the locale.
NODEspecifies the configuration file that is run on all worker nodes.
OAUTHSIGNINGCERTIFICATEspecifies the certificate with the public key that is used to sign OAuth tokens.
OAUTHSIGNINGKEYspecifies the text of the key that is used to sign OAuth tokens.
PERMSTOREspecifies the full path to the directory that is used for permanent storage.
PORTspecifies the server port number. Clients can connect to the server on the network port.
PREVSERVERINSTANCEPod name of previous server instance
PRIVACYSTATEMENTURL for privacy statement displayed by CAS Server Monitor.
PROVLISTspecifies the list of authentication providers.
REMOVENODECANCELTIMEOUTspecifies the time to wait, in seconds, before running actions are canceled. Canceling the actions can facilitate the timely completion of a removeNode action. Specify 0 to indicate that actions are never canceled.
REMOVENODEKILLTIMEOUTspecifies the time to wait, in seconds, before session processes to are killed. Killing the sessions can facilitate the timely completion of a removeNode action. Specify 0 to indicate that sessions are never killed. The time-out begins when the removeNodeCancelTimeout expires.
RESOLVEWORKERADDRESSspecifies to look up the IP addresses of worker nodes that join a server elastically.
S2FORMATSEARCHSearch path for User Defined Format Libraries that have been published to SingleStore for use by the EP.
SCALEDOWNMODEDetermine which behaivor should be used when reducing the number of worker pods on a running CAS server. Default is suspend.
SERVICESBASEURLspecifies the URL of the base services.
SESSIONspecifies the server session ID, from the SESSION command.
STARTUPspecifies the file name of the configuration file that the server runs before the server accepts any client connections. The start-up file contains CAS actions that the server runs as it starts.
STARTUPDIRServer Directory of Start-up Files
STATETRANSFERMODELDetermines the strategy to use when the state of a CAS is transferred to a new server. The mode 'suspend' is likely to leave the server unresponsive for a larger window of time. The mode 'readonly' may see attempts to update promoted tables fail.
SUBSETSESSIONCOPIESspecifies number of backup copies of blocks for in-memory tables to create in subset sessions.
TAGServer launch tag identifier
TENANTIDSpecifies the tenant ID for the server.
TIMEZONEspecifies the time zone offset, in hours, from UTC.
TIMEOUTspecifies the session time-out.
TRANSFERDIRDirectory for state transfer between server instances
TRANSFERSESSIONWhen set to True, this session will be included when transferring state to a new server.
TRANSFERINTERRUPTTIMEOUTCancel timeout for server state transfer
TRANSFERKILLTIMEOUTSession kill timeout for server state transfer
USEGPUspecifies to offload work to a GPU, if available.
USERLOCspecifies the default directory for each user's CASUSER personal caslib. You can specify %%USER to substitute a user's ID for part of the path.
USEYARNspecifies to request resources from YARN before a server accepts client connections.
YEARCUTOFFSpecifies the first year of a 100-year span that is used by date informats and functions to read a two-digit year.

Examples

FAQ

ADDNODECANCELTIMEOUT
ADDNODEKILLTIMEOUT
APPTAG
AZUREAUTHCACHELOC
AZURETENANTID
BIGINT
BIGINTPROCESSING
CASLIB
CFG
CFGNAME
CFGPATH
CMPLIB
CMPOPT
COLLATE
CONTROLPID
CPUSHARES
DATASTEPFMTERR
DATASTEPMERGENOBY
DATASTEPMSGSUMLEVEL
DATASTEPREPLACETABLE
DATASTEPVARLENCHK
DATESTYLE
DCEXTPORT
DCHOSTNAMERESOLUTION
DCPORT
DCSSLCERTISS
DCSSLCERTLOC
DCSSLCERTSERIAL
DCSSLCERTSUBJ
DCSSLPKCS12LOC
DCSSLPKCS12PASS
DCSSLPVTKEYLOC
DCSSLPVTKEYPASS
DCSSLPVTKEYPASSLOC
DCTCPMENCRYPT
DCTCPMENCRYPTALGORITHM
DEBUGOPT
DEFAULTMEMORYFORMAT
DEFAULTREP
DEFAULTTABLEREPLICATION
DQLOCALE
DQQKBREPOLOC
DQSETUPLOC
ELASTIC
ENCRYPTFIPS
EVENTDS
EXECUTABLE
EXTHOSTKNOWNBY
FMTERR
FMTSEARCH
GCPORT
HISTORYLINELENGTH
HOSTKNOWNBY
HTTPPORT
HTTPPORTMAX
ID
INITIALBACKUPS
INITIALWORKERS
INSTALL
INTERVALDS
JOIN
JREOPTIONS
KEYFILE
LIFETIME
LOCALE
LOGFLUSHTIME
LOGCFGLOC
MACHINELIST
MAXSESSIONTRANSFERSIZE
MAXTABLEMEM
MAXCORES
MAXCORESPERWORKER
MAXSESSIONS
MEMORYSIZE
MESSAGELEVEL
METRICS
NWORKERS
NEXTSERVERINSTANCE
NLDECSEPARATOR
NODE
OAUTHSIGNINGCERTIFICATE
OAUTHSIGNINGKEY
PERMSTORE
PORT
PREVSERVERINSTANCE
PRIVACYSTATEMENT
PROVLIST
REMOVENODECANCELTIMEOUT
REMOVENODEKILLTIMEOUT
RESOLVEWORKERADDRESS
S2FORMATSEARCH
SCALEDOWNMODE
SERVICESBASEURL
SESSION
STARTUP
STARTUPDIR
STATETRANSFERMODEL
SUBSETSESSIONCOPIES
TAG
TENANTID
TIMEZONE
TIMEOUT
TRANSFERDIR
TRANSFERSESSION
TRANSFERINTERRUPTTIMEOUT
TRANSFERKILLTIMEOUT
USEGPU
USERLOC
USEYARN
YEARCUTOFF