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
name specifies 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".
ADDNODECANCELTIMEOUT specifies 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.
ADDNODEKILLTIMEOUT specifies 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.
APPTAG specifies a string that is included in the appTag property of CAS Server action log messages.
AZUREAUTHCACHELOC specifies the path to the cache for Azure storage authorization.
AZURETENANTID specifies the tenant ID for Azure storage.
BIGINT New 64-bit integer processing
BIGINTPROCESSING New 64-bit integer processing
CASLIB specifies the caslib name to set as the active caslib.
CFG The server configuration file
CFGNAME The CAS server configuration name
CFGPATH CAS Server config install location
CMPLIB specifies one or more SAS data sets that contain compiler subroutines to include during compilation.
CMPOPT specifies code generation optimizations.
COLLATE specifies the collating sequence for sorting.
CONTROLPID The Process Identifier of the server that launched this instance
CPUSHARES specifies the shares for the CPU CGroup created for the server.
DATASTEPFMTERR when 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.
DATASTEPMERGENOBY when a DATA step merge is run with no BY statement, this parameter determines whether no warning, a warning, or an error message is generated.
DATASTEPMSGSUMLEVEL specifies 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.
DATASTEPREPLACETABLE specifies whether DATA step can replace an existing table.
DATASTEPVARLENCHK when 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.
DATESTYLE Specifies the sequence of month, day, and year when ANYDTDTE, ANYDTDTM, or ANYDTTME informat data is ambiguous.
DCEXTPORT specifies 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.
DCHOSTNAMERESOLUTION specifies the host name for the SAS Embedded Process.
DCPORT specifies 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.
DCSSLCERTISS specifies the name of the issuer of the digital certificate that TLS should use.
DCSSLCERTLOC specifies the location of the digital certificate for the machine's public key. This is used for authentication.
DCSSLCERTSERIAL specifies the serial number of the digital certificate that TLS uses.
DCSSLCERTSUBJ specifies the subject name of the digital certificate that TLS uses.
DCSSLPKCS12LOC specifies the location of the PKCS #12 encoding package file.
DCSSLPKCS12PASS specifies the password that TLS requires for decrypting the private key.
DCSSLPVTKEYLOC specifies the location of the private key corresponding to the digital certificate.
DCSSLPVTKEYPASS specifies the password that TLS requires for decrypting the private key.
DCSSLPVTKEYPASSLOC specifies the file containing the password that TLS requires for decrypting the private key.
DCTCPMENCRYPT specifies use of encryption for the communication partner.
DCTCPMENCRYPTALGORITHM specifies the encryption algorithm to use.
DEBUGOPT Debugger options
DEFAULTMEMORYFORMAT specifies the default memory format for session tables.
DEFAULTREP Default new table replication factor
DEFAULTTABLEREPLICATION Default new table replication factor
DQLOCALE specifies the default locale to use for data quality operations. Use a 5-letter locale code.
DQQKBREPOLOC specifies the name of the caslib where QKBs are stored.
DQSETUPLOC specifies the name of the default QKB to use for data quality operations.
ELASTIC The server option to provide run-time grid expansion; requires 'keyfile' option
ENCRYPTFIPS use only FIPS 140-2 compliant algorithms.
EVENTDS specifies one or more event objects that define custom date events.
EXECUTABLE specifies the server session executable name.
EXTHOSTKNOWNBY specifies 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.
FMTERR when 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.
FMTSEARCH specifies the format search list to set during start-up of a session.
GCPORT specifies the port number for inter-node communication on a distributed server.
HISTORYLINELENGTH specifies the maximum history line length.
HOSTKNOWNBY specifies the DNS name that other nodes should use to connect to this machine.
HTTPPORT specifies the port number for the HTTP interface to the server.
HTTPPORTMAX specifies the maximum port range value for the HTTP interface port.
ID specifies the server rank that is assigned at run-time.
INITIALBACKUPS specifies the minimum number of backup controllers that must connect before the server accepts client requests.
INITIALWORKERS specifies the minimum number of workers that must connect before the server accepts client requests.
INSTALL specifies the server installation path.
INTERVALDS specifies interval object pairs.
JOIN specifies the name of the server to join, from the JOIN command.
JREOPTIONS specifies the JRE options.
KEYFILE specifies the full path to the key file.
LIFETIME specifies the server lifetime, in minutes. A value of 0 indicates that the server runs indefinitely.
LOCALE specifies the locale to use for sorting and formatting.
LOGFLUSHTIME specifies 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.
LOGCFGLOC specifies the full path to the log configuration file.
MACHINELIST specifies the full path to file on the controller host that lists the machines in the distributed server.
MAXSESSIONTRANSFERSIZE Maximum amount of session local data for sessions to transfer to new server.
MAXTABLEMEM specifies 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.
MAXCORES specifies 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.
MAXCORESPERWORKER specifies the maximum cores per worker.
MAXSESSIONS specifies the maximum number of concurrent sessions. Users who can assume an administrative role are not subject to the limit.
MEMORYSIZE specifies the memory limit, in bytes, for a CGroup and YARN request.
MESSAGELEVEL specifies the log message level.
METRICS when set to True, action metrics are displayed.
NWORKERS specifies the number of worker nodes associated with this session.
NEXTSERVERINSTANCE Pod name of next server instance
NLDECSEPARATOR When set to True, enables numeric output to format using the decimal separator for the locale.
NODE specifies the configuration file that is run on all worker nodes.
OAUTHSIGNINGCERTIFICATE specifies the certificate with the public key that is used to sign OAuth tokens.
OAUTHSIGNINGKEY specifies the text of the key that is used to sign OAuth tokens.
PERMSTORE specifies the full path to the directory that is used for permanent storage.
PORT specifies the server port number. Clients can connect to the server on the network port.
PREVSERVERINSTANCE Pod name of previous server instance
PRIVACYSTATEMENT URL for privacy statement displayed by CAS Server Monitor.
PROVLIST specifies the list of authentication providers.
REMOVENODECANCELTIMEOUT specifies 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.
REMOVENODEKILLTIMEOUT specifies 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.
RESOLVEWORKERADDRESS specifies to look up the IP addresses of worker nodes that join a server elastically.
S2FORMATSEARCH Search path for User Defined Format Libraries that have been published to SingleStore for use by the EP.
SCALEDOWNMODE Determine which behaivor should be used when reducing the number of worker pods on a running CAS server. Default is suspend.
SERVICESBASEURL specifies the URL of the base services.
SESSION specifies the server session ID, from the SESSION command.
STARTUP specifies 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.
STARTUPDIR Server Directory of Start-up Files
STATETRANSFERMODEL Determines 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.
SUBSETSESSIONCOPIES specifies number of backup copies of blocks for in-memory tables to create in subset sessions.
TAG Server launch tag identifier
TENANTID Specifies the tenant ID for the server.
TIMEZONE specifies the time zone offset, in hours, from UTC.
TIMEOUT specifies the session time-out.
TRANSFERDIR Directory for state transfer between server instances
TRANSFERSESSION When set to True, this session will be included when transferring state to a new server.
TRANSFERINTERRUPTTIMEOUT Cancel timeout for server state transfer
TRANSFERKILLTIMEOUT Session kill timeout for server state transfer
USEGPU specifies to offload work to a GPU, if available.
USERLOC specifies 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.
USEYARN specifies to request resources from YARN before a server accepts client connections.
YEARCUTOFF Specifies 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