Docs Packages
  1. Packages
  2. Splunk
  3. API Docs
  4. OutputsTcpSyslog
Splunk v1.2.8 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-splunk

splunk.OutputsTcpSyslog

Explore with Pulumi AI

splunk logo
Splunk v1.2.8 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-splunk

    # Resource: splunk.OutputsTcpSyslog

    Access the configuration of a forwarded server configured to provide data in standard syslog format.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as splunk from "@pulumi/splunk";

const tcpSyslog = new splunk.OutputsTcpSyslog("tcp_syslog", {
    name: "new-syslog",
    server: "new-host-1:1234",
    priority: 5,
});

    import pulumi
import pulumi_splunk as splunk

tcp_syslog = splunk.OutputsTcpSyslog("tcp_syslog",
    name="new-syslog",
    server="new-host-1:1234",
    priority=5)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := splunk.NewOutputsTcpSyslog(ctx, "tcp_syslog", &splunk.OutputsTcpSyslogArgs{
			Name:     pulumi.String("new-syslog"),
			Server:   pulumi.String("new-host-1:1234"),
			Priority: pulumi.Int(5),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Splunk = Pulumi.Splunk;

return await Deployment.RunAsync(() => 
{
    var tcpSyslog = new Splunk.OutputsTcpSyslog("tcp_syslog", new()
    {
        Name = "new-syslog",
        Server = "new-host-1:1234",
        Priority = 5,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.splunk.OutputsTcpSyslog;
import com.pulumi.splunk.OutputsTcpSyslogArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var tcpSyslog = new OutputsTcpSyslog("tcpSyslog", OutputsTcpSyslogArgs.builder()
            .name("new-syslog")
            .server("new-host-1:1234")
            .priority(5)
            .build());

    }
}

    resources:
  tcpSyslog:
    type: splunk:OutputsTcpSyslog
    name: tcp_syslog
    properties:
      name: new-syslog
      server: new-host-1:1234
      priority: 5

    Create OutputsTcpSyslog Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new OutputsTcpSyslog(name: string, args?: OutputsTcpSyslogArgs, opts?: CustomResourceOptions);
    @overload
def OutputsTcpSyslog(resource_name: str,
                     args: Optional[OutputsTcpSyslogArgs] = None,
                     opts: Optional[ResourceOptions] = None)

@overload
def OutputsTcpSyslog(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     acl: Optional[OutputsTcpSyslogAclArgs] = None,
                     disabled: Optional[bool] = None,
                     name: Optional[str] = None,
                     priority: Optional[int] = None,
                     server: Optional[str] = None,
                     syslog_sourcetype: Optional[str] = None,
                     timestamp_format: Optional[str] = None,
                     type: Optional[str] = None)
    func NewOutputsTcpSyslog(ctx *Context, name string, args *OutputsTcpSyslogArgs, opts ...ResourceOption) (*OutputsTcpSyslog, error)
    public OutputsTcpSyslog(string name, OutputsTcpSyslogArgs? args = null, CustomResourceOptions? opts = null)
    public OutputsTcpSyslog(String name, OutputsTcpSyslogArgs args)
public OutputsTcpSyslog(String name, OutputsTcpSyslogArgs args, CustomResourceOptions options)

    type: splunk:OutputsTcpSyslog
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args OutputsTcpSyslogArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args OutputsTcpSyslogArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args OutputsTcpSyslogArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OutputsTcpSyslogArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OutputsTcpSyslogArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var outputsTcpSyslogResource = new Splunk.OutputsTcpSyslog("outputsTcpSyslogResource", new()
{
    Acl = new Splunk.Inputs.OutputsTcpSyslogAclArgs
    {
        App = "string",
        CanChangePerms = false,
        CanShareApp = false,
        CanShareGlobal = false,
        CanShareUser = false,
        CanWrite = false,
        Owner = "string",
        Reads = new[]
        {
            "string",
        },
        Removable = false,
        Sharing = "string",
        Writes = new[]
        {
            "string",
        },
    },
    Disabled = false,
    Name = "string",
    Priority = 0,
    Server = "string",
    SyslogSourcetype = "string",
    TimestampFormat = "string",
    Type = "string",
});

    example, err := splunk.NewOutputsTcpSyslog(ctx, "outputsTcpSyslogResource", &splunk.OutputsTcpSyslogArgs{
	Acl: &splunk.OutputsTcpSyslogAclArgs{
		App:            pulumi.String("string"),
		CanChangePerms: pulumi.Bool(false),
		CanShareApp:    pulumi.Bool(false),
		CanShareGlobal: pulumi.Bool(false),
		CanShareUser:   pulumi.Bool(false),
		CanWrite:       pulumi.Bool(false),
		Owner:          pulumi.String("string"),
		Reads: pulumi.StringArray{
			pulumi.String("string"),
		},
		Removable: pulumi.Bool(false),
		Sharing:   pulumi.String("string"),
		Writes: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	Disabled:         pulumi.Bool(false),
	Name:             pulumi.String("string"),
	Priority:         pulumi.Int(0),
	Server:           pulumi.String("string"),
	SyslogSourcetype: pulumi.String("string"),
	TimestampFormat:  pulumi.String("string"),
	Type:             pulumi.String("string"),
})

    var outputsTcpSyslogResource = new OutputsTcpSyslog("outputsTcpSyslogResource", OutputsTcpSyslogArgs.builder()
    .acl(OutputsTcpSyslogAclArgs.builder()
        .app("string")
        .canChangePerms(false)
        .canShareApp(false)
        .canShareGlobal(false)
        .canShareUser(false)
        .canWrite(false)
        .owner("string")
        .reads("string")
        .removable(false)
        .sharing("string")
        .writes("string")
        .build())
    .disabled(false)
    .name("string")
    .priority(0)
    .server("string")
    .syslogSourcetype("string")
    .timestampFormat("string")
    .type("string")
    .build());

    outputs_tcp_syslog_resource = splunk.OutputsTcpSyslog("outputsTcpSyslogResource",
    acl=splunk.OutputsTcpSyslogAclArgs(
        app="string",
        can_change_perms=False,
        can_share_app=False,
        can_share_global=False,
        can_share_user=False,
        can_write=False,
        owner="string",
        reads=["string"],
        removable=False,
        sharing="string",
        writes=["string"],
    ),
    disabled=False,
    name="string",
    priority=0,
    server="string",
    syslog_sourcetype="string",
    timestamp_format="string",
    type="string")

    const outputsTcpSyslogResource = new splunk.OutputsTcpSyslog("outputsTcpSyslogResource", {
    acl: {
        app: "string",
        canChangePerms: false,
        canShareApp: false,
        canShareGlobal: false,
        canShareUser: false,
        canWrite: false,
        owner: "string",
        reads: ["string"],
        removable: false,
        sharing: "string",
        writes: ["string"],
    },
    disabled: false,
    name: "string",
    priority: 0,
    server: "string",
    syslogSourcetype: "string",
    timestampFormat: "string",
    type: "string",
});

    type: splunk:OutputsTcpSyslog
properties:
    acl:
        app: string
        canChangePerms: false
        canShareApp: false
        canShareGlobal: false
        canShareUser: false
        canWrite: false
        owner: string
        reads:
            - string
        removable: false
        sharing: string
        writes:
            - string
    disabled: false
    name: string
    priority: 0
    server: string
    syslogSourcetype: string
    timestampFormat: string
    type: string

    OutputsTcpSyslog Resource Properties

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

    Inputs

    The OutputsTcpSyslog resource accepts the following input properties:

    Acl OutputsTcpSyslogAcl
    The app/user context that is the namespace for the resource
    Disabled bool
    If true, disables global syslog settings.
    Name string
    Name of the syslog output group. This is name used when creating syslog configuration in outputs.conf.
    Priority int
    Sets syslog priority value. The priority value should specified as an integer. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
    Server string
    host:port of the server where syslog data should be sent
    SyslogSourcetype string
    Specifies a rule for handling data in addition to that provided by the "syslog" sourcetype. By default, there is no value for syslogSourceType. This string is used as a substring match against the sourcetype key. For example, if the string is set to 'syslog', then all source types containing the string "syslog" receives this special treatment. To match a source type explicitly, use the pattern "sourcetype::sourcetype_name." For example syslogSourcetype = sourcetype::apache_common Data that is "syslog" or matches this setting is assumed to already be in syslog format. Data that does not match the rules has a header, potentially a timestamp, and a hostname added to the front of the event. This is how Splunk software causes arbitrary log data to match syslog expectations.
    TimestampFormat string
    Format of timestamp to add at start of the events to be forwarded. The format is a strftime-style timestamp formatting string. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
    Type string
    Protocol to use to send syslog data. Valid values: (tcp | udp ).
    Acl OutputsTcpSyslogAclArgs
    The app/user context that is the namespace for the resource
    Disabled bool
    If true, disables global syslog settings.
    Name string
    Name of the syslog output group. This is name used when creating syslog configuration in outputs.conf.
    Priority int
    Sets syslog priority value. The priority value should specified as an integer. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
    Server string
    host:port of the server where syslog data should be sent
    SyslogSourcetype string
    Specifies a rule for handling data in addition to that provided by the "syslog" sourcetype. By default, there is no value for syslogSourceType. This string is used as a substring match against the sourcetype key. For example, if the string is set to 'syslog', then all source types containing the string "syslog" receives this special treatment. To match a source type explicitly, use the pattern "sourcetype::sourcetype_name." For example syslogSourcetype = sourcetype::apache_common Data that is "syslog" or matches this setting is assumed to already be in syslog format. Data that does not match the rules has a header, potentially a timestamp, and a hostname added to the front of the event. This is how Splunk software causes arbitrary log data to match syslog expectations.
    TimestampFormat string
    Format of timestamp to add at start of the events to be forwarded. The format is a strftime-style timestamp formatting string. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
    Type string
    Protocol to use to send syslog data. Valid values: (tcp | udp ).
    acl OutputsTcpSyslogAcl
    The app/user context that is the namespace for the resource
    disabled Boolean
    If true, disables global syslog settings.
    name String
    Name of the syslog output group. This is name used when creating syslog configuration in outputs.conf.
    priority Integer
    Sets syslog priority value. The priority value should specified as an integer. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
    server String
    host:port of the server where syslog data should be sent
    syslogSourcetype String
    Specifies a rule for handling data in addition to that provided by the "syslog" sourcetype. By default, there is no value for syslogSourceType. This string is used as a substring match against the sourcetype key. For example, if the string is set to 'syslog', then all source types containing the string "syslog" receives this special treatment. To match a source type explicitly, use the pattern "sourcetype::sourcetype_name." For example syslogSourcetype = sourcetype::apache_common Data that is "syslog" or matches this setting is assumed to already be in syslog format. Data that does not match the rules has a header, potentially a timestamp, and a hostname added to the front of the event. This is how Splunk software causes arbitrary log data to match syslog expectations.
    timestampFormat String
    Format of timestamp to add at start of the events to be forwarded. The format is a strftime-style timestamp formatting string. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
    type String
    Protocol to use to send syslog data. Valid values: (tcp | udp ).
    acl OutputsTcpSyslogAcl
    The app/user context that is the namespace for the resource
    disabled boolean
    If true, disables global syslog settings.
    name string
    Name of the syslog output group. This is name used when creating syslog configuration in outputs.conf.
    priority number
    Sets syslog priority value. The priority value should specified as an integer. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
    server string
    host:port of the server where syslog data should be sent
    syslogSourcetype string
    Specifies a rule for handling data in addition to that provided by the "syslog" sourcetype. By default, there is no value for syslogSourceType. This string is used as a substring match against the sourcetype key. For example, if the string is set to 'syslog', then all source types containing the string "syslog" receives this special treatment. To match a source type explicitly, use the pattern "sourcetype::sourcetype_name." For example syslogSourcetype = sourcetype::apache_common Data that is "syslog" or matches this setting is assumed to already be in syslog format. Data that does not match the rules has a header, potentially a timestamp, and a hostname added to the front of the event. This is how Splunk software causes arbitrary log data to match syslog expectations.
    timestampFormat string
    Format of timestamp to add at start of the events to be forwarded. The format is a strftime-style timestamp formatting string. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
    type string
    Protocol to use to send syslog data. Valid values: (tcp | udp ).
    acl OutputsTcpSyslogAclArgs
    The app/user context that is the namespace for the resource
    disabled bool
    If true, disables global syslog settings.
    name str
    Name of the syslog output group. This is name used when creating syslog configuration in outputs.conf.
    priority int
    Sets syslog priority value. The priority value should specified as an integer. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
    server str
    host:port of the server where syslog data should be sent
    syslog_sourcetype str
    Specifies a rule for handling data in addition to that provided by the "syslog" sourcetype. By default, there is no value for syslogSourceType. This string is used as a substring match against the sourcetype key. For example, if the string is set to 'syslog', then all source types containing the string "syslog" receives this special treatment. To match a source type explicitly, use the pattern "sourcetype::sourcetype_name." For example syslogSourcetype = sourcetype::apache_common Data that is "syslog" or matches this setting is assumed to already be in syslog format. Data that does not match the rules has a header, potentially a timestamp, and a hostname added to the front of the event. This is how Splunk software causes arbitrary log data to match syslog expectations.
    timestamp_format str
    Format of timestamp to add at start of the events to be forwarded. The format is a strftime-style timestamp formatting string. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
    type str
    Protocol to use to send syslog data. Valid values: (tcp | udp ).
    acl Property Map
    The app/user context that is the namespace for the resource
    disabled Boolean
    If true, disables global syslog settings.
    name String
    Name of the syslog output group. This is name used when creating syslog configuration in outputs.conf.
    priority Number
    Sets syslog priority value. The priority value should specified as an integer. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
    server String
    host:port of the server where syslog data should be sent
    syslogSourcetype String
    Specifies a rule for handling data in addition to that provided by the "syslog" sourcetype. By default, there is no value for syslogSourceType. This string is used as a substring match against the sourcetype key. For example, if the string is set to 'syslog', then all source types containing the string "syslog" receives this special treatment. To match a source type explicitly, use the pattern "sourcetype::sourcetype_name." For example syslogSourcetype = sourcetype::apache_common Data that is "syslog" or matches this setting is assumed to already be in syslog format. Data that does not match the rules has a header, potentially a timestamp, and a hostname added to the front of the event. This is how Splunk software causes arbitrary log data to match syslog expectations.
    timestampFormat String
    Format of timestamp to add at start of the events to be forwarded. The format is a strftime-style timestamp formatting string. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
    type String
    Protocol to use to send syslog data. Valid values: (tcp | udp ).

    Outputs

    All input properties are implicitly available as output properties. Additionally, the OutputsTcpSyslog 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 string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing OutputsTcpSyslog Resource

    Get an existing OutputsTcpSyslog 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?: OutputsTcpSyslogState, opts?: CustomResourceOptions): OutputsTcpSyslog
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        acl: Optional[OutputsTcpSyslogAclArgs] = None,
        disabled: Optional[bool] = None,
        name: Optional[str] = None,
        priority: Optional[int] = None,
        server: Optional[str] = None,
        syslog_sourcetype: Optional[str] = None,
        timestamp_format: Optional[str] = None,
        type: Optional[str] = None) -> OutputsTcpSyslog
    func GetOutputsTcpSyslog(ctx *Context, name string, id IDInput, state *OutputsTcpSyslogState, opts ...ResourceOption) (*OutputsTcpSyslog, error)
    public static OutputsTcpSyslog Get(string name, Input<string> id, OutputsTcpSyslogState? state, CustomResourceOptions? opts = null)
    public static OutputsTcpSyslog get(String name, Output<String> id, OutputsTcpSyslogState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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 OutputsTcpSyslogAcl
    The app/user context that is the namespace for the resource
    Disabled bool
    If true, disables global syslog settings.
    Name string
    Name of the syslog output group. This is name used when creating syslog configuration in outputs.conf.
    Priority int
    Sets syslog priority value. The priority value should specified as an integer. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
    Server string
    host:port of the server where syslog data should be sent
    SyslogSourcetype string
    Specifies a rule for handling data in addition to that provided by the "syslog" sourcetype. By default, there is no value for syslogSourceType. This string is used as a substring match against the sourcetype key. For example, if the string is set to 'syslog', then all source types containing the string "syslog" receives this special treatment. To match a source type explicitly, use the pattern "sourcetype::sourcetype_name." For example syslogSourcetype = sourcetype::apache_common Data that is "syslog" or matches this setting is assumed to already be in syslog format. Data that does not match the rules has a header, potentially a timestamp, and a hostname added to the front of the event. This is how Splunk software causes arbitrary log data to match syslog expectations.
    TimestampFormat string
    Format of timestamp to add at start of the events to be forwarded. The format is a strftime-style timestamp formatting string. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
    Type string
    Protocol to use to send syslog data. Valid values: (tcp | udp ).
    Acl OutputsTcpSyslogAclArgs
    The app/user context that is the namespace for the resource
    Disabled bool
    If true, disables global syslog settings.
    Name string
    Name of the syslog output group. This is name used when creating syslog configuration in outputs.conf.
    Priority int
    Sets syslog priority value. The priority value should specified as an integer. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
    Server string
    host:port of the server where syslog data should be sent
    SyslogSourcetype string
    Specifies a rule for handling data in addition to that provided by the "syslog" sourcetype. By default, there is no value for syslogSourceType. This string is used as a substring match against the sourcetype key. For example, if the string is set to 'syslog', then all source types containing the string "syslog" receives this special treatment. To match a source type explicitly, use the pattern "sourcetype::sourcetype_name." For example syslogSourcetype = sourcetype::apache_common Data that is "syslog" or matches this setting is assumed to already be in syslog format. Data that does not match the rules has a header, potentially a timestamp, and a hostname added to the front of the event. This is how Splunk software causes arbitrary log data to match syslog expectations.
    TimestampFormat string
    Format of timestamp to add at start of the events to be forwarded. The format is a strftime-style timestamp formatting string. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
    Type string
    Protocol to use to send syslog data. Valid values: (tcp | udp ).
    acl OutputsTcpSyslogAcl
    The app/user context that is the namespace for the resource
    disabled Boolean
    If true, disables global syslog settings.
    name String
    Name of the syslog output group. This is name used when creating syslog configuration in outputs.conf.
    priority Integer
    Sets syslog priority value. The priority value should specified as an integer. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
    server String
    host:port of the server where syslog data should be sent
    syslogSourcetype String
    Specifies a rule for handling data in addition to that provided by the "syslog" sourcetype. By default, there is no value for syslogSourceType. This string is used as a substring match against the sourcetype key. For example, if the string is set to 'syslog', then all source types containing the string "syslog" receives this special treatment. To match a source type explicitly, use the pattern "sourcetype::sourcetype_name." For example syslogSourcetype = sourcetype::apache_common Data that is "syslog" or matches this setting is assumed to already be in syslog format. Data that does not match the rules has a header, potentially a timestamp, and a hostname added to the front of the event. This is how Splunk software causes arbitrary log data to match syslog expectations.
    timestampFormat String
    Format of timestamp to add at start of the events to be forwarded. The format is a strftime-style timestamp formatting string. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
    type String
    Protocol to use to send syslog data. Valid values: (tcp | udp ).
    acl OutputsTcpSyslogAcl
    The app/user context that is the namespace for the resource
    disabled boolean
    If true, disables global syslog settings.
    name string
    Name of the syslog output group. This is name used when creating syslog configuration in outputs.conf.
    priority number
    Sets syslog priority value. The priority value should specified as an integer. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
    server string
    host:port of the server where syslog data should be sent
    syslogSourcetype string
    Specifies a rule for handling data in addition to that provided by the "syslog" sourcetype. By default, there is no value for syslogSourceType. This string is used as a substring match against the sourcetype key. For example, if the string is set to 'syslog', then all source types containing the string "syslog" receives this special treatment. To match a source type explicitly, use the pattern "sourcetype::sourcetype_name." For example syslogSourcetype = sourcetype::apache_common Data that is "syslog" or matches this setting is assumed to already be in syslog format. Data that does not match the rules has a header, potentially a timestamp, and a hostname added to the front of the event. This is how Splunk software causes arbitrary log data to match syslog expectations.
    timestampFormat string
    Format of timestamp to add at start of the events to be forwarded. The format is a strftime-style timestamp formatting string. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
    type string
    Protocol to use to send syslog data. Valid values: (tcp | udp ).
    acl OutputsTcpSyslogAclArgs
    The app/user context that is the namespace for the resource
    disabled bool
    If true, disables global syslog settings.
    name str
    Name of the syslog output group. This is name used when creating syslog configuration in outputs.conf.
    priority int
    Sets syslog priority value. The priority value should specified as an integer. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
    server str
    host:port of the server where syslog data should be sent
    syslog_sourcetype str
    Specifies a rule for handling data in addition to that provided by the "syslog" sourcetype. By default, there is no value for syslogSourceType. This string is used as a substring match against the sourcetype key. For example, if the string is set to 'syslog', then all source types containing the string "syslog" receives this special treatment. To match a source type explicitly, use the pattern "sourcetype::sourcetype_name." For example syslogSourcetype = sourcetype::apache_common Data that is "syslog" or matches this setting is assumed to already be in syslog format. Data that does not match the rules has a header, potentially a timestamp, and a hostname added to the front of the event. This is how Splunk software causes arbitrary log data to match syslog expectations.
    timestamp_format str
    Format of timestamp to add at start of the events to be forwarded. The format is a strftime-style timestamp formatting string. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
    type str
    Protocol to use to send syslog data. Valid values: (tcp | udp ).
    acl Property Map
    The app/user context that is the namespace for the resource
    disabled Boolean
    If true, disables global syslog settings.
    name String
    Name of the syslog output group. This is name used when creating syslog configuration in outputs.conf.
    priority Number
    Sets syslog priority value. The priority value should specified as an integer. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
    server String
    host:port of the server where syslog data should be sent
    syslogSourcetype String
    Specifies a rule for handling data in addition to that provided by the "syslog" sourcetype. By default, there is no value for syslogSourceType. This string is used as a substring match against the sourcetype key. For example, if the string is set to 'syslog', then all source types containing the string "syslog" receives this special treatment. To match a source type explicitly, use the pattern "sourcetype::sourcetype_name." For example syslogSourcetype = sourcetype::apache_common Data that is "syslog" or matches this setting is assumed to already be in syslog format. Data that does not match the rules has a header, potentially a timestamp, and a hostname added to the front of the event. This is how Splunk software causes arbitrary log data to match syslog expectations.
    timestampFormat String
    Format of timestamp to add at start of the events to be forwarded. The format is a strftime-style timestamp formatting string. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
    type String
    Protocol to use to send syslog data. Valid values: (tcp | udp ).

    Supporting Types

    OutputsTcpSyslogAcl, OutputsTcpSyslogAclArgs

    App string
    The app context for the resource. Required for updating saved search ACL properties. Allowed values are:The name of an app and system
    CanChangePerms bool
    Indicates if the active user can change permissions for this object. Defaults to true.
    CanShareApp bool
    Indicates if the active user can change sharing to app level. Defaults to true.
    CanShareGlobal bool
    Indicates if the active user can change sharing to system level. Defaults to true.
    CanShareUser bool
    Indicates if the active user can change sharing to user level. Defaults to true.
    CanWrite bool
    Indicates if the active user can edit this object. Defaults to true.
    Owner string
    User name of resource owner. Defaults to the resource creator. Required for updating any knowledge object ACL properties.nobody = All users may access the resource, but write access to the resource might be restricted.
    Reads List<string>
    Properties that indicate resource read permissions.
    Removable bool
    Indicates whether an admin or user with sufficient permissions can delete the entity.
    Sharing string
    Indicates how the resource is shared. Required for updating any knowledge object ACL properties.app: Shared within a specific appglobal: (Default) Shared globally to all apps.user: Private to a user
    Writes List<string>
    Properties that indicate write permissions of the resource.
    App string
    The app context for the resource. Required for updating saved search ACL properties. Allowed values are:The name of an app and system
    CanChangePerms bool
    Indicates if the active user can change permissions for this object. Defaults to true.
    CanShareApp bool
    Indicates if the active user can change sharing to app level. Defaults to true.
    CanShareGlobal bool
    Indicates if the active user can change sharing to system level. Defaults to true.
    CanShareUser bool
    Indicates if the active user can change sharing to user level. Defaults to true.
    CanWrite bool
    Indicates if the active user can edit this object. Defaults to true.
    Owner string
    User name of resource owner. Defaults to the resource creator. Required for updating any knowledge object ACL properties.nobody = All users may access the resource, but write access to the resource might be restricted.
    Reads []string
    Properties that indicate resource read permissions.
    Removable bool
    Indicates whether an admin or user with sufficient permissions can delete the entity.
    Sharing string
    Indicates how the resource is shared. Required for updating any knowledge object ACL properties.app: Shared within a specific appglobal: (Default) Shared globally to all apps.user: Private to a user
    Writes []string
    Properties that indicate write permissions of the resource.
    app String
    The app context for the resource. Required for updating saved search ACL properties. Allowed values are:The name of an app and system
    canChangePerms Boolean
    Indicates if the active user can change permissions for this object. Defaults to true.
    canShareApp Boolean
    Indicates if the active user can change sharing to app level. Defaults to true.
    canShareGlobal Boolean
    Indicates if the active user can change sharing to system level. Defaults to true.
    canShareUser Boolean
    Indicates if the active user can change sharing to user level. Defaults to true.
    canWrite Boolean
    Indicates if the active user can edit this object. Defaults to true.
    owner String
    User name of resource owner. Defaults to the resource creator. Required for updating any knowledge object ACL properties.nobody = All users may access the resource, but write access to the resource might be restricted.
    reads List<String>
    Properties that indicate resource read permissions.
    removable Boolean
    Indicates whether an admin or user with sufficient permissions can delete the entity.
    sharing String
    Indicates how the resource is shared. Required for updating any knowledge object ACL properties.app: Shared within a specific appglobal: (Default) Shared globally to all apps.user: Private to a user
    writes List<String>
    Properties that indicate write permissions of the resource.
    app string
    The app context for the resource. Required for updating saved search ACL properties. Allowed values are:The name of an app and system
    canChangePerms boolean
    Indicates if the active user can change permissions for this object. Defaults to true.
    canShareApp boolean
    Indicates if the active user can change sharing to app level. Defaults to true.
    canShareGlobal boolean
    Indicates if the active user can change sharing to system level. Defaults to true.
    canShareUser boolean
    Indicates if the active user can change sharing to user level. Defaults to true.
    canWrite boolean
    Indicates if the active user can edit this object. Defaults to true.
    owner string
    User name of resource owner. Defaults to the resource creator. Required for updating any knowledge object ACL properties.nobody = All users may access the resource, but write access to the resource might be restricted.
    reads string[]
    Properties that indicate resource read permissions.
    removable boolean
    Indicates whether an admin or user with sufficient permissions can delete the entity.
    sharing string
    Indicates how the resource is shared. Required for updating any knowledge object ACL properties.app: Shared within a specific appglobal: (Default) Shared globally to all apps.user: Private to a user
    writes string[]
    Properties that indicate write permissions of the resource.
    app str
    The app context for the resource. Required for updating saved search ACL properties. Allowed values are:The name of an app and system
    can_change_perms bool
    Indicates if the active user can change permissions for this object. Defaults to true.
    can_share_app bool
    Indicates if the active user can change sharing to app level. Defaults to true.
    can_share_global bool
    Indicates if the active user can change sharing to system level. Defaults to true.
    can_share_user bool
    Indicates if the active user can change sharing to user level. Defaults to true.
    can_write bool
    Indicates if the active user can edit this object. Defaults to true.
    owner str
    User name of resource owner. Defaults to the resource creator. Required for updating any knowledge object ACL properties.nobody = All users may access the resource, but write access to the resource might be restricted.
    reads Sequence[str]
    Properties that indicate resource read permissions.
    removable bool
    Indicates whether an admin or user with sufficient permissions can delete the entity.
    sharing str
    Indicates how the resource is shared. Required for updating any knowledge object ACL properties.app: Shared within a specific appglobal: (Default) Shared globally to all apps.user: Private to a user
    writes Sequence[str]
    Properties that indicate write permissions of the resource.
    app String
    The app context for the resource. Required for updating saved search ACL properties. Allowed values are:The name of an app and system
    canChangePerms Boolean
    Indicates if the active user can change permissions for this object. Defaults to true.
    canShareApp Boolean
    Indicates if the active user can change sharing to app level. Defaults to true.
    canShareGlobal Boolean
    Indicates if the active user can change sharing to system level. Defaults to true.
    canShareUser Boolean
    Indicates if the active user can change sharing to user level. Defaults to true.
    canWrite Boolean
    Indicates if the active user can edit this object. Defaults to true.
    owner String
    User name of resource owner. Defaults to the resource creator. Required for updating any knowledge object ACL properties.nobody = All users may access the resource, but write access to the resource might be restricted.
    reads List<String>
    Properties that indicate resource read permissions.
    removable Boolean
    Indicates whether an admin or user with sufficient permissions can delete the entity.
    sharing String
    Indicates how the resource is shared. Required for updating any knowledge object ACL properties.app: Shared within a specific appglobal: (Default) Shared globally to all apps.user: Private to a user
    writes List<String>
    Properties that indicate write permissions of the resource.

    Package Details

    Repository
    Splunk pulumi/pulumi-splunk
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the splunk Terraform Provider.
    splunk logo
    Splunk v1.2.8 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-splunk