Book Demo!

Available Fields for Additional Functionality

˂ Return to FAQ

New Xton Documentation Center
Xton help has moved. Please visit the current version of this page for the most recent updates. Our new documentation center can be found at help.xtontech.com.

Custom Fields Added to Record Types for Enhanced Functionality

This article lists all the custom fields that can be added to specific Record Types to enable additional functionality in XTAM. Note that these fields cannot be used with all record types, so please be sure to read the description of each before adding them to your XTAM instance.

Please see our Creating New Fields for information about how to create fields in XTAM record types.

    • AD Query
      • Description: Used to define a standard LDAP query against the host in order to execute tasks against the query results. More information can be found in our Host Queries for Mass Script Execution article.
      • Field Type: String
      • Name: ADQuery
      • Display Name: AD Query
      • Example: (&(objectclass=computer)(objectcategory=computer)(cn=DEV*))
    • Agent Forwarding (SSH)
      • Description: Can be added to Unix Host with Key, Unix Host with Private Key or inherited record types to enable connecting to the destination server through one or more bastion hosts using the same set of public and private key pair managed in the system vault.
      • Field Type: Checkbox
      • Name: AgentForwarding
      • Display Name: Agent Forwarding
      • Example: Enabled/Checked to enable SSH Agent Forwarding on this record.
    • Command
      • Description: Can be added to a SSH based record type to execute a specific command upon login. Used in conjunction with the Command Password field to authenticate the command. More information can be found in our Automatic Command Execution During SSH Login article.
      • Field Type: String
      • Name: Command
      • Display Name: Remote Command
      • Example: mysql -u admin -p -h 10.0.0.33 Master to connect using the MySQL client.
    • Command Password
      • Description: If the Command field above requires a password, enter this password to authorize that command.
      • Field Type: String
      • Name: CommandPassword
      • Display Name: Command Password
      • Secured: Enabled/Checked
      • Example: The password for -u admin in the previous Command field.
    • Connection
      • Description: Used to define a complete connection string for Oracle RDBMS connections.
      • Field Type: String
      • Name: Connection
      • Display Name: Connection
      • Example: host:1521:SID
    • Console
      • Description: Used to connect to the RDP console session (Windows Server 2003) in case a record has the Console field set to true (checked)
      • Field Type: Checkbox
      • Name: Console
      • Display Name: Console
      • Example: Enabled/Checked to connect to the RDP console session.
    • Enable Level
      • Description: Used to define the Enable level when switching to Cisco’s Enable mode after login.
      • Field Type: Number
      • Name: EnableLevel
      • Display Name: Enable Level
      • Example: 15
    • Enable Password
      • Description: Used to define the Enable password when switching to Cisco’s Enable mode after login.
      • Field Type: String
      • Name: EnablePassword
      • Display Name: Enable Password
      • Secured: Enabled/Checked
      • Example: yourPassword
    • Enabled
      • Description: Used to define which Remote Application Host record is enabled for operations.
      • Field Type: Checkbox
      • Name: Enabled
      • Display Name: Enabled
      • Example: Enabled/Checked to enable for operations, Disable/Unchecked to disable for operations.
    • File Transfer Control
      • Description: Used to overwrite the global Session File Transfer parameter (Administration > Settings > Parameters > Session File Transfer) on individual records.
      • Field Type: Choice
      • Name: FileTransfer
      • Display Name: File Transfer Control
      • Values: Use Global,Enabled,Disabled
      • Example: Use Global or no selection to use the globally defined configuration for sessions connected with this record, Enabled to overwrite the globally defined configuration and allow File Transfers for sessions connected with this record or Disabled to overwrite the globally defined configuration and disallow File Transfers for sessions connected with this record.
    • File Transfer Disabled
      • Description: Used to disable a request for the file transfer protocol (SFTP) during Unix sessions.
      • Field Type: Checkbox
      • Name: FileTransferDisabled
      • Display Name: File Transfer Disabled
      • Example: Enabled/Checked to disable request for SFTP.
    • Filter
      • Description: String field to define a comma-separated list of record types served by the specific Remote Application Host record.
      • Field Type: String
      • Name: Filter
      • Display Name: Filter
      • Example: MySQL Workbench,MS SQL Studio to enable only these record types to operate with this Remote Application Host.
    • Font Smoothing
      • Description: Used, on a record level, to enable nice font rendering during Windows connections at the expense of the increased network traffic. Font Smoothing can also be enabled on a global or user preference level, but this configuration will take precedence over those settings.
      • Field Type: Choice
      • Name: FontSmoothing
      • Display Name: Font Smoothing
      • Values: enabled,disabled
      • Example: enabled to force font smoothing, disabled to allow for the global or user preference setting to be used.
    • Host Name DNS
      • Description: This is used to verify a remote Windows host name match with the host name on the record before executing any script on the remote computer in order to detect mis-configured or attacked name resolution service. Checking the field disables the option to verify host for the specific record.
      • Field Type: Checkbox
      • Name: HostNameDNS
      • Display Name: Host Name DNS
      • Example: Unchecked to enable, Checked to disable.
    • Key Size
      • Description: This is used to specify the size of the key generated for Unix public key rotation.
      • Field Type: Choice
      • Name: KeySize
      • Display Name: Key Size
      • Values: 1024,2048,4096,8192
      • Example: 4096
    • Password Attribute
      • Description: Used to a configure custom password attribute to support password reset for non-OpenLDAP compliant user directories. Use this custom field PasswordAttribute in a LDAP Server record type to define the LDAP password attribute relevant to this specific user directory server. More information can be found in our OpenLDAP Automated Password Reset article.
      • Field Type: String
      • Name: PasswordAttribute
      • Display Name: Password Attribute
      • Example: Your non-OpenLDAP password attribute value other than the expected userPassword
    • Platform
      • Description: Used to define the Remote Application Host platform; Windows RDS or TSPlus.
      • Field Type: Choice
      • Name: Platform
      • Display Name: Platform
      • Values: Windows RDS,TSPlus
      • Example: Windows RDS
    • Prologue
      • Description: Used to send a sequence into the remote device at the start of the connection when using native applications through the system’s SSH Proxy.
      • Field Type: String
      • Name: Prologue
      • Display Name: Prologue
      • Example: dbaccess life to execute this command to access an Informix database immediately after a successful connection.
    • Resize On Connect Delay
      • Description: Used to disable a screen resize and keeps the initial default screen size.
      • Field Type: String
      • Name: ResizeOnConnectDelay
      • Display Name: Resize On Connect Delay
      • Example: -1 to disable the resize.
    • Screen Size
      • Description: Used to control the screen size for SSH and Telnet sessions target blocked graphical applications on the remote Unix systems that require fixed screen size for their optimal performance. It defines the target screen resolution and is provided in the format WIDTHxHEIGHT in pixels for sizes larger than 320×200 or in COLSxROWS in characters for the sizes smaller than 320×200.
      • Field Type: String
      • Name: ScreenSize
      • Display Name: Screen Size
      • Example: 1024×748 in pixels or 80×24 in characters.
    • Service
      • Description: Service or SID name for Oracle RDBMS connections used in combination with Host and Port to build a connection string. Service parameter not started with / or : is treated as a service. Service parameter may start with / to be treated as a service. Service parameter may start with : to be treated as an SID.
      • Field Type: String
      • Name: Service
      • Display Name: Service
      • Example: :xtam
    • Service Port
      • Description: This parameter defines a custom port for password reset and job execution for the Windows Remote PowerShell strategy using WinRM protocol by specifying the port number in the record type. Default port value is 5985.
      • Field Type: Number
      • Name: ServicePort
      • Display Name: Service Port
      • Example: 1234
    • Terminal
      • Description: This parameter sets the terminal emulator type string that is passed to the SSH server. This parameter is optional and if not specified, “linux” is used as the terminal emulator type by default. Examples of terminal strings include VT52, VT100, VT220, VT320, xterm and ANSI.
      • Field Type: String or Choice
      • Name: Terminal
      • Display Name: Terminal
      • Values: enter a list of terminal emulator strings that can be selected by record creator or editors.
      • Example: VT100
    • Traffic Interceptor Hints
      • Description: Used to define a non-standard port(s) for use with capturing SQL traffic when an XTAM SSH Tunnel is being used. The hint is a comma-, space- or semicolon-separated list of protocols and ports that should be recorded.
      • Field Type: String
      • Name: TrafficIntercepterHints or TrafficInterceptorHints
      • Display Name: Traffic Intercepter Hints or Traffic Interceptor Hints
      • Example: mssql:1444 mysql:3333
    • Transport Security
      • Description: Used to select a specific transport security level for RDP connections.
      • Field Type: Choice
      • Name: TransportSecurity
      • Display Name: Transport Security
      • Values: rdp,nla,tls,any
      • Example: Select tls from the Transport Security dropdown menu to establish the RDP connection using tls.
    • VNC Password
      • Description: Used to define a VNC Host password to enable referencing an unlock user password or the OS user from the other record. XTAM is able to unlock the user session using the account password on the record to present high trust login to the actual user desktop through the VNC protocol
      • Field Type: String
      • Name: VNCPassword
      • Display Name: VNC Password
      • Secured: Enabled/Checked
      • Example: yourVNCpassword
    • Windows Theme (RDP in-browser sessions)
      • Description: Used to define whether the Windows Theme of the destination server will be enabled during in-browser sessions. Windows Theme is disabled by default for performance considerations.
      • Field Type: Choice
      • Name: Theming
      • Display Name: Theming
      • Values: Disabled,Enabled
      • Example: Enabled
    • Windows Wallpaper (RDP in-browser sessions)
      • Description: Used to define whether the Windows Wallpaper of the destination server will be displayed during in-browser sessions. Windows Wallpaper is disabled by default for performance considerations.
      • Field Type: Choice
      • Name: Wallpaper
      • Display Name: Wallpaper
      • Values: Disabled,Enabled
      • Example: Enabled

 

Legal | Privacy Policy
Copyright © 2020 Xton Technologies, LLC. All rights reserved.