IngestListener is a datatype for ingest Listeners listen on a port for UDP or TCP traffic, used with SysLog.

This datatype is used by the createIngestListenerV3() and updateIngestListenerV3() mutation fields, as well as by the ingestListeners parameter of the key datatype, Repository, which is used by several GraphQL queries and mutations.

Table: IngestListener

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Sep 25, 2024
bindInterfacestringyes Long-TermThe ip address this listener will bind to. By default (leaving this field empty) it will bind to 0.0.0.0 - all interfaces. Using this field it is also possible to specify the address to bind to. In a cluster setup it is also possible to specify if only one machine should open a socket - The vhost field is used for that.
charsetstringyes Long-TermThe character set used to decode the event stream. Available character sets depend on the JVM running the LogScale instance. Names and aliases can be found at http://www.iana.org/assignments/character-sets/character-sets.xhtml
idstringyes Long-TermThe unique identifier for the ingest listener.
namestringyes Long-TermThe name of the ingest listener.
parserParser  Long-TermThe parser configured to parse data for the listener. It returns null if the parser has been removed since the listener was created. See Parser.
portintegeryes Long-TermThe TCP/UDP port on which to listen.
protocolIngestListenerProtocolyes Long-TermThe network protocol data is sent through. See IngestListenerProtocol.
repositoryRepositoryyes Long-TermThe repository associated with the ingest listener. See Repository.
vHostinteger  Long-TermSpecify which host should open the socket. By default this field is empty and all hosts will open a socket. This field can be used to select only one host to open the socket.