createIngestListenerV3()

The createIngestListenerV3() GraphQL mutation may be used to create a new ingest listener.

For more information on ingest listeners, see the Ingest Listeners documentation page. You may also want to look at the Ingesting Data page for related information.

Syntax

Below is the syntax for the createIngestListenerV3() mutation field:

graphql
createIngestListenerV2(
      input: CreateIngestListenerV2Input!
   ): IngestListener!

Given Datatypes

For the input CreateIngestListenerV2Input, there are several parameters that may be given. Below is a list of them along with their datatypes and a description of each:

Table: CreateIngestListenerV2Input

ParameterTypeRequired[a]DefaultDescription
repositoryNamestringyes Name of the repository.
portintegeryes The TCP/UDP port the ingest listener will listen on.
protocolIngestListenerProtocolyes The kind of listener; TCP, UDP, Netflow/UDP, GELF/UDP, GELF/TCP.
vHostinteger  The vHost name for the ingest listener.
namestringyes Name of the ingest listener.
bindInterfacestringyes The IP address that to which the ingest listener will bind.
parserIdstringyes The identifier of the parser to assign to the ingest listener.
charsetstringyes The charset used to decode the event stream.

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.


Returned Datatypes

The returned datatype IngestListener has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: IngestListener

ParameterTypeRequired[a]DefaultDescription
idstringyes The unique identifier for the ingest listener.
repositoryRepositoryyes The repository associated with the ingest listener (see Repository Table).
portintegeryes The TCP/UDP port on which to listen.
protocolIngestListenerProtocolyes The network protocol data is sent through (see IngestListenerProtocol Table).
charsetstringyes The 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
parserParseryes The parser configured to parse data for the listener. It returns null if the parser has been removed since the listener was created (see Parser Table).
vHostinteger  Specify 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.
namestringyes The name of the ingest listener.
bindInterfacestringyes The 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.

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.