Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

OutputsTcpDefault

# Resource: splunk.OutputsTcpDefault

Manage to global tcpout properties.

Example Usage

using Pulumi;
using Splunk = Pulumi.Splunk;

class MyStack : Stack
{
    public MyStack()
    {
        var tcpDefault = new Splunk.OutputsTcpDefault("tcpDefault", new Splunk.OutputsTcpDefaultArgs
        {
            DefaultGroup = "test-indexers",
            Disabled = false,
            DropEventsOnQueueFull = 60,
            IndexAndForward = true,
            MaxQueueSize = "100KB",
            SendCookedData = true,
        });
    }

}
package main

import (
    "github.com/pulumi/pulumi-splunk/sdk/go/splunk"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := splunk.NewOutputsTcpDefault(ctx, "tcpDefault", &splunk.OutputsTcpDefaultArgs{
            DefaultGroup:          pulumi.String("test-indexers"),
            Disabled:              pulumi.Bool(false),
            DropEventsOnQueueFull: pulumi.Int(60),
            IndexAndForward:       pulumi.Bool(true),
            MaxQueueSize:          pulumi.String("100KB"),
            SendCookedData:        pulumi.Bool(true),
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_splunk as splunk

tcp_default = splunk.OutputsTcpDefault("tcpDefault",
    default_group="test-indexers",
    disabled=False,
    drop_events_on_queue_full=60,
    index_and_forward=True,
    max_queue_size="100KB",
    send_cooked_data=True)
import * as pulumi from "@pulumi/pulumi";
import * as splunk from "@pulumi/splunk";

const tcpDefault = new splunk.OutputsTcpDefault("tcp_default", {
    defaultGroup: "test-indexers",
    disabled: false,
    dropEventsOnQueueFull: 60,
    indexAndForward: true,
    maxQueueSize: "100KB",
    sendCookedData: true,
});

Create a OutputsTcpDefault Resource

new OutputsTcpDefault(name: string, args?: OutputsTcpDefaultArgs, opts?: CustomResourceOptions);
def OutputsTcpDefault(resource_name: str, opts: Optional[ResourceOptions] = None, acl: Optional[OutputsTcpDefaultAclArgs] = None, default_group: Optional[str] = None, disabled: Optional[bool] = None, drop_events_on_queue_full: Optional[int] = None, heartbeat_frequency: Optional[int] = None, index_and_forward: Optional[bool] = None, max_queue_size: Optional[str] = None, name: Optional[str] = None, send_cooked_data: Optional[bool] = None)
func NewOutputsTcpDefault(ctx *Context, name string, args *OutputsTcpDefaultArgs, opts ...ResourceOption) (*OutputsTcpDefault, error)
public OutputsTcpDefault(string name, OutputsTcpDefaultArgs? args = null, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args OutputsTcpDefaultArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args OutputsTcpDefaultArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args OutputsTcpDefaultArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

OutputsTcpDefault Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The OutputsTcpDefault resource accepts the following input properties:

Acl OutputsTcpDefaultAclArgs

The app/user context that is the namespace for the resource

DefaultGroup string

Comma-separated list of one or more target group names, specified later in [tcpout:] stanzas of outputs.conf.spec file. The forwarder sends all data to the specified groups. If you do not want to forward data automatically, do not set this attribute. Can be overridden by an inputs.conf _TCP_ROUTING setting, which in turn can be overridden by a props.conf/transforms.conf modifier.

Disabled bool

Disables default tcpout settings

DropEventsOnQueueFull int

If set to a positive number, wait the specified number of seconds before throwing out all new events until the output queue has space. Defaults to -1 (do not drop events).
CAUTION: Do not set this value to a positive integer if you are monitoring files. Setting this to -1 or 0 causes the output queue to block when it gets full, which causes further blocking up the processing chain. If any target group queue is blocked, no more data reaches any other target group. Using auto load-balancing is the best way to minimize this condition, because, in that case, multiple receivers must be down (or jammed up) before queue blocking can occur.

HeartbeatFrequency int

How often (in seconds) to send a heartbeat packet to the receiving server. Heartbeats are only sent if sendCookedData=true. Defaults to 30 seconds.

IndexAndForward bool

Specifies whether to index all data locally, in addition to forwarding it. Defaults to false. This is known as an “index-and-forward” configuration. This attribute is only available for heavy forwarders. It is available only at the top level [tcpout] stanza in outputs.conf. It cannot be overridden in a target group.

MaxQueueSize string

Specify an integer or integer[KB|MB|GB].
Sets the maximum size of the forwarder output queue. It also sets the maximum size of the wait queue to 3x this value, if you have enabled indexer acknowledgment (useACK=true). Although the wait queue and the output queues are both configured by this attribute, they are separate queues. The setting determines the maximum size of the queue in-memory (RAM) buffer. For heavy forwarders sending parsed data, maxQueueSize is the maximum number of events. Since events are typically much shorter than data blocks, the memory consumed by the queue on a parsing forwarder is likely to be much smaller than on a non-parsing forwarder, if you use this version of the setting. If specified as a lone integer (for example, maxQueueSize=100), maxQueueSize indicates the maximum number of queued events (for parsed data) or blocks of data (for unparsed data). A block of data is approximately 64KB. For non-parsing forwarders, such as universal forwarders, that send unparsed data, maxQueueSize is the maximum number of data blocks. If specified as an integer followed by KB, MB, or GB (for example, maxQueueSize=100MB), maxQueueSize indicates the maximum RAM allocated to the queue buffer. Defaults to 500KB (which means a maximum size of 500KB for the output queue and 1500KB for the wait queue, if any).

Name string

Configuration to be edited. The only valid value is “tcpout”.

SendCookedData bool

If true, events are cooked (processed by Splunk software). If false, events are raw and untouched prior to sending. Defaults to true. Set to false if you are sending to a third-party system.

Acl OutputsTcpDefaultAcl

The app/user context that is the namespace for the resource

DefaultGroup string

Comma-separated list of one or more target group names, specified later in [tcpout:] stanzas of outputs.conf.spec file. The forwarder sends all data to the specified groups. If you do not want to forward data automatically, do not set this attribute. Can be overridden by an inputs.conf _TCP_ROUTING setting, which in turn can be overridden by a props.conf/transforms.conf modifier.

Disabled bool

Disables default tcpout settings

DropEventsOnQueueFull int

If set to a positive number, wait the specified number of seconds before throwing out all new events until the output queue has space. Defaults to -1 (do not drop events).
CAUTION: Do not set this value to a positive integer if you are monitoring files. Setting this to -1 or 0 causes the output queue to block when it gets full, which causes further blocking up the processing chain. If any target group queue is blocked, no more data reaches any other target group. Using auto load-balancing is the best way to minimize this condition, because, in that case, multiple receivers must be down (or jammed up) before queue blocking can occur.

HeartbeatFrequency int

How often (in seconds) to send a heartbeat packet to the receiving server. Heartbeats are only sent if sendCookedData=true. Defaults to 30 seconds.

IndexAndForward bool

Specifies whether to index all data locally, in addition to forwarding it. Defaults to false. This is known as an “index-and-forward” configuration. This attribute is only available for heavy forwarders. It is available only at the top level [tcpout] stanza in outputs.conf. It cannot be overridden in a target group.

MaxQueueSize string

Specify an integer or integer[KB|MB|GB].
Sets the maximum size of the forwarder output queue. It also sets the maximum size of the wait queue to 3x this value, if you have enabled indexer acknowledgment (useACK=true). Although the wait queue and the output queues are both configured by this attribute, they are separate queues. The setting determines the maximum size of the queue in-memory (RAM) buffer. For heavy forwarders sending parsed data, maxQueueSize is the maximum number of events. Since events are typically much shorter than data blocks, the memory consumed by the queue on a parsing forwarder is likely to be much smaller than on a non-parsing forwarder, if you use this version of the setting. If specified as a lone integer (for example, maxQueueSize=100), maxQueueSize indicates the maximum number of queued events (for parsed data) or blocks of data (for unparsed data). A block of data is approximately 64KB. For non-parsing forwarders, such as universal forwarders, that send unparsed data, maxQueueSize is the maximum number of data blocks. If specified as an integer followed by KB, MB, or GB (for example, maxQueueSize=100MB), maxQueueSize indicates the maximum RAM allocated to the queue buffer. Defaults to 500KB (which means a maximum size of 500KB for the output queue and 1500KB for the wait queue, if any).

Name string

Configuration to be edited. The only valid value is “tcpout”.

SendCookedData bool

If true, events are cooked (processed by Splunk software). If false, events are raw and untouched prior to sending. Defaults to true. Set to false if you are sending to a third-party system.

acl OutputsTcpDefaultAcl

The app/user context that is the namespace for the resource

defaultGroup string

Comma-separated list of one or more target group names, specified later in [tcpout:] stanzas of outputs.conf.spec file. The forwarder sends all data to the specified groups. If you do not want to forward data automatically, do not set this attribute. Can be overridden by an inputs.conf _TCP_ROUTING setting, which in turn can be overridden by a props.conf/transforms.conf modifier.

disabled boolean

Disables default tcpout settings

dropEventsOnQueueFull number

If set to a positive number, wait the specified number of seconds before throwing out all new events until the output queue has space. Defaults to -1 (do not drop events).
CAUTION: Do not set this value to a positive integer if you are monitoring files. Setting this to -1 or 0 causes the output queue to block when it gets full, which causes further blocking up the processing chain. If any target group queue is blocked, no more data reaches any other target group. Using auto load-balancing is the best way to minimize this condition, because, in that case, multiple receivers must be down (or jammed up) before queue blocking can occur.

heartbeatFrequency number

How often (in seconds) to send a heartbeat packet to the receiving server. Heartbeats are only sent if sendCookedData=true. Defaults to 30 seconds.

indexAndForward boolean

Specifies whether to index all data locally, in addition to forwarding it. Defaults to false. This is known as an “index-and-forward” configuration. This attribute is only available for heavy forwarders. It is available only at the top level [tcpout] stanza in outputs.conf. It cannot be overridden in a target group.

maxQueueSize string

Specify an integer or integer[KB|MB|GB].
Sets the maximum size of the forwarder output queue. It also sets the maximum size of the wait queue to 3x this value, if you have enabled indexer acknowledgment (useACK=true). Although the wait queue and the output queues are both configured by this attribute, they are separate queues. The setting determines the maximum size of the queue in-memory (RAM) buffer. For heavy forwarders sending parsed data, maxQueueSize is the maximum number of events. Since events are typically much shorter than data blocks, the memory consumed by the queue on a parsing forwarder is likely to be much smaller than on a non-parsing forwarder, if you use this version of the setting. If specified as a lone integer (for example, maxQueueSize=100), maxQueueSize indicates the maximum number of queued events (for parsed data) or blocks of data (for unparsed data). A block of data is approximately 64KB. For non-parsing forwarders, such as universal forwarders, that send unparsed data, maxQueueSize is the maximum number of data blocks. If specified as an integer followed by KB, MB, or GB (for example, maxQueueSize=100MB), maxQueueSize indicates the maximum RAM allocated to the queue buffer. Defaults to 500KB (which means a maximum size of 500KB for the output queue and 1500KB for the wait queue, if any).

name string

Configuration to be edited. The only valid value is “tcpout”.

sendCookedData boolean

If true, events are cooked (processed by Splunk software). If false, events are raw and untouched prior to sending. Defaults to true. Set to false if you are sending to a third-party system.

acl OutputsTcpDefaultAclArgs

The app/user context that is the namespace for the resource

default_group str

Comma-separated list of one or more target group names, specified later in [tcpout:] stanzas of outputs.conf.spec file. The forwarder sends all data to the specified groups. If you do not want to forward data automatically, do not set this attribute. Can be overridden by an inputs.conf _TCP_ROUTING setting, which in turn can be overridden by a props.conf/transforms.conf modifier.

disabled bool

Disables default tcpout settings

drop_events_on_queue_full int

If set to a positive number, wait the specified number of seconds before throwing out all new events until the output queue has space. Defaults to -1 (do not drop events).
CAUTION: Do not set this value to a positive integer if you are monitoring files. Setting this to -1 or 0 causes the output queue to block when it gets full, which causes further blocking up the processing chain. If any target group queue is blocked, no more data reaches any other target group. Using auto load-balancing is the best way to minimize this condition, because, in that case, multiple receivers must be down (or jammed up) before queue blocking can occur.

heartbeat_frequency int

How often (in seconds) to send a heartbeat packet to the receiving server. Heartbeats are only sent if sendCookedData=true. Defaults to 30 seconds.

index_and_forward bool

Specifies whether to index all data locally, in addition to forwarding it. Defaults to false. This is known as an “index-and-forward” configuration. This attribute is only available for heavy forwarders. It is available only at the top level [tcpout] stanza in outputs.conf. It cannot be overridden in a target group.

max_queue_size str

Specify an integer or integer[KB|MB|GB].
Sets the maximum size of the forwarder output queue. It also sets the maximum size of the wait queue to 3x this value, if you have enabled indexer acknowledgment (useACK=true). Although the wait queue and the output queues are both configured by this attribute, they are separate queues. The setting determines the maximum size of the queue in-memory (RAM) buffer. For heavy forwarders sending parsed data, maxQueueSize is the maximum number of events. Since events are typically much shorter than data blocks, the memory consumed by the queue on a parsing forwarder is likely to be much smaller than on a non-parsing forwarder, if you use this version of the setting. If specified as a lone integer (for example, maxQueueSize=100), maxQueueSize indicates the maximum number of queued events (for parsed data) or blocks of data (for unparsed data). A block of data is approximately 64KB. For non-parsing forwarders, such as universal forwarders, that send unparsed data, maxQueueSize is the maximum number of data blocks. If specified as an integer followed by KB, MB, or GB (for example, maxQueueSize=100MB), maxQueueSize indicates the maximum RAM allocated to the queue buffer. Defaults to 500KB (which means a maximum size of 500KB for the output queue and 1500KB for the wait queue, if any).

name str

Configuration to be edited. The only valid value is “tcpout”.

send_cooked_data bool

If true, events are cooked (processed by Splunk software). If false, events are raw and untouched prior to sending. Defaults to true. Set to false if you are sending to a third-party system.

Outputs

All input properties are implicitly available as output properties. Additionally, the OutputsTcpDefault resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing OutputsTcpDefault Resource

Get an existing OutputsTcpDefault resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: OutputsTcpDefaultState, opts?: CustomResourceOptions): OutputsTcpDefault
@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, acl: Optional[OutputsTcpDefaultAclArgs] = None, default_group: Optional[str] = None, disabled: Optional[bool] = None, drop_events_on_queue_full: Optional[int] = None, heartbeat_frequency: Optional[int] = None, index_and_forward: Optional[bool] = None, max_queue_size: Optional[str] = None, name: Optional[str] = None, send_cooked_data: Optional[bool] = None) -> OutputsTcpDefault
func GetOutputsTcpDefault(ctx *Context, name string, id IDInput, state *OutputsTcpDefaultState, opts ...ResourceOption) (*OutputsTcpDefault, error)
public static OutputsTcpDefault Get(string name, Input<string> id, OutputsTcpDefaultState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

Acl OutputsTcpDefaultAclArgs

The app/user context that is the namespace for the resource

DefaultGroup string

Comma-separated list of one or more target group names, specified later in [tcpout:] stanzas of outputs.conf.spec file. The forwarder sends all data to the specified groups. If you do not want to forward data automatically, do not set this attribute. Can be overridden by an inputs.conf _TCP_ROUTING setting, which in turn can be overridden by a props.conf/transforms.conf modifier.

Disabled bool

Disables default tcpout settings

DropEventsOnQueueFull int

If set to a positive number, wait the specified number of seconds before throwing out all new events until the output queue has space. Defaults to -1 (do not drop events).
CAUTION: Do not set this value to a positive integer if you are monitoring files. Setting this to -1 or 0 causes the output queue to block when it gets full, which causes further blocking up the processing chain. If any target group queue is blocked, no more data reaches any other target group. Using auto load-balancing is the best way to minimize this condition, because, in that case, multiple receivers must be down (or jammed up) before queue blocking can occur.

HeartbeatFrequency int

How often (in seconds) to send a heartbeat packet to the receiving server. Heartbeats are only sent if sendCookedData=true. Defaults to 30 seconds.

IndexAndForward bool

Specifies whether to index all data locally, in addition to forwarding it. Defaults to false. This is known as an “index-and-forward” configuration. This attribute is only available for heavy forwarders. It is available only at the top level [tcpout] stanza in outputs.conf. It cannot be overridden in a target group.

MaxQueueSize string

Specify an integer or integer[KB|MB|GB].
Sets the maximum size of the forwarder output queue. It also sets the maximum size of the wait queue to 3x this value, if you have enabled indexer acknowledgment (useACK=true). Although the wait queue and the output queues are both configured by this attribute, they are separate queues. The setting determines the maximum size of the queue in-memory (RAM) buffer. For heavy forwarders sending parsed data, maxQueueSize is the maximum number of events. Since events are typically much shorter than data blocks, the memory consumed by the queue on a parsing forwarder is likely to be much smaller than on a non-parsing forwarder, if you use this version of the setting. If specified as a lone integer (for example, maxQueueSize=100), maxQueueSize indicates the maximum number of queued events (for parsed data) or blocks of data (for unparsed data). A block of data is approximately 64KB. For non-parsing forwarders, such as universal forwarders, that send unparsed data, maxQueueSize is the maximum number of data blocks. If specified as an integer followed by KB, MB, or GB (for example, maxQueueSize=100MB), maxQueueSize indicates the maximum RAM allocated to the queue buffer. Defaults to 500KB (which means a maximum size of 500KB for the output queue and 1500KB for the wait queue, if any).

Name string

Configuration to be edited. The only valid value is “tcpout”.

SendCookedData bool

If true, events are cooked (processed by Splunk software). If false, events are raw and untouched prior to sending. Defaults to true. Set to false if you are sending to a third-party system.

Acl OutputsTcpDefaultAcl

The app/user context that is the namespace for the resource

DefaultGroup string

Comma-separated list of one or more target group names, specified later in [tcpout:] stanzas of outputs.conf.spec file. The forwarder sends all data to the specified groups. If you do not want to forward data automatically, do not set this attribute. Can be overridden by an inputs.conf _TCP_ROUTING setting, which in turn can be overridden by a props.conf/transforms.conf modifier.

Disabled bool

Disables default tcpout settings

DropEventsOnQueueFull int

If set to a positive number, wait the specified number of seconds before throwing out all new events until the output queue has space. Defaults to -1 (do not drop events).
CAUTION: Do not set this value to a positive integer if you are monitoring files. Setting this to -1 or 0 causes the output queue to block when it gets full, which causes further blocking up the processing chain. If any target group queue is blocked, no more data reaches any other target group. Using auto load-balancing is the best way to minimize this condition, because, in that case, multiple receivers must be down (or jammed up) before queue blocking can occur.

HeartbeatFrequency int

How often (in seconds) to send a heartbeat packet to the receiving server. Heartbeats are only sent if sendCookedData=true. Defaults to 30 seconds.

IndexAndForward bool

Specifies whether to index all data locally, in addition to forwarding it. Defaults to false. This is known as an “index-and-forward” configuration. This attribute is only available for heavy forwarders. It is available only at the top level [tcpout] stanza in outputs.conf. It cannot be overridden in a target group.

MaxQueueSize string

Specify an integer or integer[KB|MB|GB].
Sets the maximum size of the forwarder output queue. It also sets the maximum size of the wait queue to 3x this value, if you have enabled indexer acknowledgment (useACK=true). Although the wait queue and the output queues are both configured by this attribute, they are separate queues. The setting determines the maximum size of the queue in-memory (RAM) buffer. For heavy forwarders sending parsed data, maxQueueSize is the maximum number of events. Since events are typically much shorter than data blocks, the memory consumed by the queue on a parsing forwarder is likely to be much smaller than on a non-parsing forwarder, if you use this version of the setting. If specified as a lone integer (for example, maxQueueSize=100), maxQueueSize indicates the maximum number of queued events (for parsed data) or blocks of data (for unparsed data). A block of data is approximately 64KB. For non-parsing forwarders, such as universal forwarders, that send unparsed data, maxQueueSize is the maximum number of data blocks. If specified as an integer followed by KB, MB, or GB (for example, maxQueueSize=100MB), maxQueueSize indicates the maximum RAM allocated to the queue buffer. Defaults to 500KB (which means a maximum size of 500KB for the output queue and 1500KB for the wait queue, if any).

Name string

Configuration to be edited. The only valid value is “tcpout”.

SendCookedData bool

If true, events are cooked (processed by Splunk software). If false, events are raw and untouched prior to sending. Defaults to true. Set to false if you are sending to a third-party system.

acl OutputsTcpDefaultAcl

The app/user context that is the namespace for the resource

defaultGroup string

Comma-separated list of one or more target group names, specified later in [tcpout:] stanzas of outputs.conf.spec file. The forwarder sends all data to the specified groups. If you do not want to forward data automatically, do not set this attribute. Can be overridden by an inputs.conf _TCP_ROUTING setting, which in turn can be overridden by a props.conf/transforms.conf modifier.

disabled boolean

Disables default tcpout settings

dropEventsOnQueueFull number

If set to a positive number, wait the specified number of seconds before throwing out all new events until the output queue has space. Defaults to -1 (do not drop events).
CAUTION: Do not set this value to a positive integer if you are monitoring files. Setting this to -1 or 0 causes the output queue to block when it gets full, which causes further blocking up the processing chain. If any target group queue is blocked, no more data reaches any other target group. Using auto load-balancing is the best way to minimize this condition, because, in that case, multiple receivers must be down (or jammed up) before queue blocking can occur.

heartbeatFrequency number

How often (in seconds) to send a heartbeat packet to the receiving server. Heartbeats are only sent if sendCookedData=true. Defaults to 30 seconds.

indexAndForward boolean

Specifies whether to index all data locally, in addition to forwarding it. Defaults to false. This is known as an “index-and-forward” configuration. This attribute is only available for heavy forwarders. It is available only at the top level [tcpout] stanza in outputs.conf. It cannot be overridden in a target group.

maxQueueSize string

Specify an integer or integer[KB|MB|GB].
Sets the maximum size of the forwarder output queue. It also sets the maximum size of the wait queue to 3x this value, if you have enabled indexer acknowledgment (useACK=true). Although the wait queue and the output queues are both configured by this attribute, they are separate queues. The setting determines the maximum size of the queue in-memory (RAM) buffer. For heavy forwarders sending parsed data, maxQueueSize is the maximum number of events. Since events are typically much shorter than data blocks, the memory consumed by the queue on a parsing forwarder is likely to be much smaller than on a non-parsing forwarder, if you use this version of the setting. If specified as a lone integer (for example, maxQueueSize=100), maxQueueSize indicates the maximum number of queued events (for parsed data) or blocks of data (for unparsed data). A block of data is approximately 64KB. For non-parsing forwarders, such as universal forwarders, that send unparsed data, maxQueueSize is the maximum number of data blocks. If specified as an integer followed by KB, MB, or GB (for example, maxQueueSize=100MB), maxQueueSize indicates the maximum RAM allocated to the queue buffer. Defaults to 500KB (which means a maximum size of 500KB for the output queue and 1500KB for the wait queue, if any).

name string

Configuration to be edited. The only valid value is “tcpout”.

sendCookedData boolean

If true, events are cooked (processed by Splunk software). If false, events are raw and untouched prior to sending. Defaults to true. Set to false if you are sending to a third-party system.

acl OutputsTcpDefaultAclArgs

The app/user context that is the namespace for the resource

default_group str

Comma-separated list of one or more target group names, specified later in [tcpout:] stanzas of outputs.conf.spec file. The forwarder sends all data to the specified groups. If you do not want to forward data automatically, do not set this attribute. Can be overridden by an inputs.conf _TCP_ROUTING setting, which in turn can be overridden by a props.conf/transforms.conf modifier.

disabled bool

Disables default tcpout settings

drop_events_on_queue_full int

If set to a positive number, wait the specified number of seconds before throwing out all new events until the output queue has space. Defaults to -1 (do not drop events).
CAUTION: Do not set this value to a positive integer if you are monitoring files. Setting this to -1 or 0 causes the output queue to block when it gets full, which causes further blocking up the processing chain. If any target group queue is blocked, no more data reaches any other target group. Using auto load-balancing is the best way to minimize this condition, because, in that case, multiple receivers must be down (or jammed up) before queue blocking can occur.

heartbeat_frequency int

How often (in seconds) to send a heartbeat packet to the receiving server. Heartbeats are only sent if sendCookedData=true. Defaults to 30 seconds.

index_and_forward bool

Specifies whether to index all data locally, in addition to forwarding it. Defaults to false. This is known as an “index-and-forward” configuration. This attribute is only available for heavy forwarders. It is available only at the top level [tcpout] stanza in outputs.conf. It cannot be overridden in a target group.

max_queue_size str

Specify an integer or integer[KB|MB|GB].
Sets the maximum size of the forwarder output queue. It also sets the maximum size of the wait queue to 3x this value, if you have enabled indexer acknowledgment (useACK=true). Although the wait queue and the output queues are both configured by this attribute, they are separate queues. The setting determines the maximum size of the queue in-memory (RAM) buffer. For heavy forwarders sending parsed data, maxQueueSize is the maximum number of events. Since events are typically much shorter than data blocks, the memory consumed by the queue on a parsing forwarder is likely to be much smaller than on a non-parsing forwarder, if you use this version of the setting. If specified as a lone integer (for example, maxQueueSize=100), maxQueueSize indicates the maximum number of queued events (for parsed data) or blocks of data (for unparsed data). A block of data is approximately 64KB. For non-parsing forwarders, such as universal forwarders, that send unparsed data, maxQueueSize is the maximum number of data blocks. If specified as an integer followed by KB, MB, or GB (for example, maxQueueSize=100MB), maxQueueSize indicates the maximum RAM allocated to the queue buffer. Defaults to 500KB (which means a maximum size of 500KB for the output queue and 1500KB for the wait queue, if any).

name str

Configuration to be edited. The only valid value is “tcpout”.

send_cooked_data bool

If true, events are cooked (processed by Splunk software). If false, events are raw and untouched prior to sending. Defaults to true. Set to false if you are sending to a third-party system.

Supporting Types

OutputsTcpDefaultAcl

App string
CanChangePerms bool
CanShareApp bool
CanShareGlobal bool
CanShareUser bool
CanWrite bool
Owner string
Reads List<string>
Removable bool
Sharing string
Writes List<string>
App string
CanChangePerms bool
CanShareApp bool
CanShareGlobal bool
CanShareUser bool
CanWrite bool
Owner string
Reads []string
Removable bool
Sharing string
Writes []string
app string
canChangePerms boolean
canShareApp boolean
canShareGlobal boolean
canShareUser boolean
canWrite boolean
owner string
reads string[]
removable boolean
sharing string
writes string[]
app str
can_change_perms bool
can_share_app bool
can_share_global bool
can_share_user bool
can_write bool
owner str
reads Sequence[str]
removable bool
sharing str
writes Sequence[str]

Package Details

Repository
https://github.com/pulumi/pulumi-splunk
License
Apache-2.0
Notes
This Pulumi package is based on the splunk Terraform Provider.