1. Packages
  2. Splunk
  3. API Docs
  4. OutputsTcpServer
Splunk v1.2.4 published on Thursday, Aug 24, 2023 by Pulumi

splunk.OutputsTcpServer

Explore with Pulumi AI

splunk logo
Splunk v1.2.4 published on Thursday, Aug 24, 2023 by Pulumi

    # Resource: splunk.OutputsTcpServer

    Access data forwarding configurations.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Splunk = Pulumi.Splunk;
    
    return await Deployment.RunAsync(() => 
    {
        var tcpServer = new Splunk.OutputsTcpServer("tcpServer", new()
        {
            SslAltNameToCheck = "old-host",
        });
    
    });
    
    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.NewOutputsTcpServer(ctx, "tcpServer", &splunk.OutputsTcpServerArgs{
    			SslAltNameToCheck: pulumi.String("old-host"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.splunk.OutputsTcpServer;
    import com.pulumi.splunk.OutputsTcpServerArgs;
    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 tcpServer = new OutputsTcpServer("tcpServer", OutputsTcpServerArgs.builder()        
                .sslAltNameToCheck("old-host")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_splunk as splunk
    
    tcp_server = splunk.OutputsTcpServer("tcpServer", ssl_alt_name_to_check="old-host")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as splunk from "@pulumi/splunk";
    
    const tcpServer = new splunk.OutputsTcpServer("tcpServer", {sslAltNameToCheck: "old-host"});
    
    resources:
      tcpServer:
        type: splunk:OutputsTcpServer
        properties:
          sslAltNameToCheck: old-host
    

    Create OutputsTcpServer Resource

    new OutputsTcpServer(name: string, args?: OutputsTcpServerArgs, opts?: CustomResourceOptions);
    @overload
    def OutputsTcpServer(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         acl: Optional[OutputsTcpServerAclArgs] = None,
                         disabled: Optional[bool] = None,
                         method: Optional[str] = None,
                         name: Optional[str] = None,
                         ssl_alt_name_to_check: Optional[str] = None,
                         ssl_cert_path: Optional[str] = None,
                         ssl_cipher: Optional[str] = None,
                         ssl_common_name_to_check: Optional[str] = None,
                         ssl_password: Optional[str] = None,
                         ssl_root_ca_path: Optional[str] = None,
                         ssl_verify_server_cert: Optional[bool] = None)
    @overload
    def OutputsTcpServer(resource_name: str,
                         args: Optional[OutputsTcpServerArgs] = None,
                         opts: Optional[ResourceOptions] = None)
    func NewOutputsTcpServer(ctx *Context, name string, args *OutputsTcpServerArgs, opts ...ResourceOption) (*OutputsTcpServer, error)
    public OutputsTcpServer(string name, OutputsTcpServerArgs? args = null, CustomResourceOptions? opts = null)
    public OutputsTcpServer(String name, OutputsTcpServerArgs args)
    public OutputsTcpServer(String name, OutputsTcpServerArgs args, CustomResourceOptions options)
    
    type: splunk:OutputsTcpServer
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args OutputsTcpServerArgs
    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 OutputsTcpServerArgs
    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 OutputsTcpServerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OutputsTcpServerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OutputsTcpServerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    OutputsTcpServer 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 OutputsTcpServer resource accepts the following input properties:

    Acl OutputsTcpServerAcl

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

    Disabled bool

    If true, disables the group.

    Method string

    Valid values: (clone | balance | autobalance) The data distribution method used when two or more servers exist in the same forwarder group.

    Name string

    : of the Splunk receiver. can be either an ip address or server name. is the that port that the Splunk receiver is listening on.

    SslAltNameToCheck string

    The alternate name to match in the remote server's SSL certificate.

    SslCertPath string

    Path to the client certificate. If specified, connection uses SSL.

    SslCipher string

    SSL Cipher in the form ALL:!aNULL:!eNULL:!LOW:!EXP:RC4+RSA:+HIGH:+MEDIUM

    SslCommonNameToCheck string

    Check the common name of the server's certificate against this name. If there is no match, assume that Splunk Enterprise is not authenticated against this server. You must specify this setting if sslVerifyServerCert is true.

    SslPassword string

    The password associated with the CAcert. The default Splunk Enterprise CAcert uses the password "password."

    SslRootCaPath string

    The path to the root certificate authority file.

    SslVerifyServerCert bool

    If true, make sure that the server you are connecting to is a valid one (authenticated). Both the common name and the alternate name of the server are then checked for a match.

    Acl OutputsTcpServerAclArgs

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

    Disabled bool

    If true, disables the group.

    Method string

    Valid values: (clone | balance | autobalance) The data distribution method used when two or more servers exist in the same forwarder group.

    Name string

    : of the Splunk receiver. can be either an ip address or server name. is the that port that the Splunk receiver is listening on.

    SslAltNameToCheck string

    The alternate name to match in the remote server's SSL certificate.

    SslCertPath string

    Path to the client certificate. If specified, connection uses SSL.

    SslCipher string

    SSL Cipher in the form ALL:!aNULL:!eNULL:!LOW:!EXP:RC4+RSA:+HIGH:+MEDIUM

    SslCommonNameToCheck string

    Check the common name of the server's certificate against this name. If there is no match, assume that Splunk Enterprise is not authenticated against this server. You must specify this setting if sslVerifyServerCert is true.

    SslPassword string

    The password associated with the CAcert. The default Splunk Enterprise CAcert uses the password "password."

    SslRootCaPath string

    The path to the root certificate authority file.

    SslVerifyServerCert bool

    If true, make sure that the server you are connecting to is a valid one (authenticated). Both the common name and the alternate name of the server are then checked for a match.

    acl OutputsTcpServerAcl

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

    disabled Boolean

    If true, disables the group.

    method String

    Valid values: (clone | balance | autobalance) The data distribution method used when two or more servers exist in the same forwarder group.

    name String

    : of the Splunk receiver. can be either an ip address or server name. is the that port that the Splunk receiver is listening on.

    sslAltNameToCheck String

    The alternate name to match in the remote server's SSL certificate.

    sslCertPath String

    Path to the client certificate. If specified, connection uses SSL.

    sslCipher String

    SSL Cipher in the form ALL:!aNULL:!eNULL:!LOW:!EXP:RC4+RSA:+HIGH:+MEDIUM

    sslCommonNameToCheck String

    Check the common name of the server's certificate against this name. If there is no match, assume that Splunk Enterprise is not authenticated against this server. You must specify this setting if sslVerifyServerCert is true.

    sslPassword String

    The password associated with the CAcert. The default Splunk Enterprise CAcert uses the password "password."

    sslRootCaPath String

    The path to the root certificate authority file.

    sslVerifyServerCert Boolean

    If true, make sure that the server you are connecting to is a valid one (authenticated). Both the common name and the alternate name of the server are then checked for a match.

    acl OutputsTcpServerAcl

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

    disabled boolean

    If true, disables the group.

    method string

    Valid values: (clone | balance | autobalance) The data distribution method used when two or more servers exist in the same forwarder group.

    name string

    : of the Splunk receiver. can be either an ip address or server name. is the that port that the Splunk receiver is listening on.

    sslAltNameToCheck string

    The alternate name to match in the remote server's SSL certificate.

    sslCertPath string

    Path to the client certificate. If specified, connection uses SSL.

    sslCipher string

    SSL Cipher in the form ALL:!aNULL:!eNULL:!LOW:!EXP:RC4+RSA:+HIGH:+MEDIUM

    sslCommonNameToCheck string

    Check the common name of the server's certificate against this name. If there is no match, assume that Splunk Enterprise is not authenticated against this server. You must specify this setting if sslVerifyServerCert is true.

    sslPassword string

    The password associated with the CAcert. The default Splunk Enterprise CAcert uses the password "password."

    sslRootCaPath string

    The path to the root certificate authority file.

    sslVerifyServerCert boolean

    If true, make sure that the server you are connecting to is a valid one (authenticated). Both the common name and the alternate name of the server are then checked for a match.

    acl OutputsTcpServerAclArgs

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

    disabled bool

    If true, disables the group.

    method str

    Valid values: (clone | balance | autobalance) The data distribution method used when two or more servers exist in the same forwarder group.

    name str

    : of the Splunk receiver. can be either an ip address or server name. is the that port that the Splunk receiver is listening on.

    ssl_alt_name_to_check str

    The alternate name to match in the remote server's SSL certificate.

    ssl_cert_path str

    Path to the client certificate. If specified, connection uses SSL.

    ssl_cipher str

    SSL Cipher in the form ALL:!aNULL:!eNULL:!LOW:!EXP:RC4+RSA:+HIGH:+MEDIUM

    ssl_common_name_to_check str

    Check the common name of the server's certificate against this name. If there is no match, assume that Splunk Enterprise is not authenticated against this server. You must specify this setting if sslVerifyServerCert is true.

    ssl_password str

    The password associated with the CAcert. The default Splunk Enterprise CAcert uses the password "password."

    ssl_root_ca_path str

    The path to the root certificate authority file.

    ssl_verify_server_cert bool

    If true, make sure that the server you are connecting to is a valid one (authenticated). Both the common name and the alternate name of the server are then checked for a match.

    acl Property Map

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

    disabled Boolean

    If true, disables the group.

    method String

    Valid values: (clone | balance | autobalance) The data distribution method used when two or more servers exist in the same forwarder group.

    name String

    : of the Splunk receiver. can be either an ip address or server name. is the that port that the Splunk receiver is listening on.

    sslAltNameToCheck String

    The alternate name to match in the remote server's SSL certificate.

    sslCertPath String

    Path to the client certificate. If specified, connection uses SSL.

    sslCipher String

    SSL Cipher in the form ALL:!aNULL:!eNULL:!LOW:!EXP:RC4+RSA:+HIGH:+MEDIUM

    sslCommonNameToCheck String

    Check the common name of the server's certificate against this name. If there is no match, assume that Splunk Enterprise is not authenticated against this server. You must specify this setting if sslVerifyServerCert is true.

    sslPassword String

    The password associated with the CAcert. The default Splunk Enterprise CAcert uses the password "password."

    sslRootCaPath String

    The path to the root certificate authority file.

    sslVerifyServerCert Boolean

    If true, make sure that the server you are connecting to is a valid one (authenticated). Both the common name and the alternate name of the server are then checked for a match.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the OutputsTcpServer 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 OutputsTcpServer Resource

    Get an existing OutputsTcpServer 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?: OutputsTcpServerState, opts?: CustomResourceOptions): OutputsTcpServer
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            acl: Optional[OutputsTcpServerAclArgs] = None,
            disabled: Optional[bool] = None,
            method: Optional[str] = None,
            name: Optional[str] = None,
            ssl_alt_name_to_check: Optional[str] = None,
            ssl_cert_path: Optional[str] = None,
            ssl_cipher: Optional[str] = None,
            ssl_common_name_to_check: Optional[str] = None,
            ssl_password: Optional[str] = None,
            ssl_root_ca_path: Optional[str] = None,
            ssl_verify_server_cert: Optional[bool] = None) -> OutputsTcpServer
    func GetOutputsTcpServer(ctx *Context, name string, id IDInput, state *OutputsTcpServerState, opts ...ResourceOption) (*OutputsTcpServer, error)
    public static OutputsTcpServer Get(string name, Input<string> id, OutputsTcpServerState? state, CustomResourceOptions? opts = null)
    public static OutputsTcpServer get(String name, Output<String> id, OutputsTcpServerState 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 OutputsTcpServerAcl

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

    Disabled bool

    If true, disables the group.

    Method string

    Valid values: (clone | balance | autobalance) The data distribution method used when two or more servers exist in the same forwarder group.

    Name string

    : of the Splunk receiver. can be either an ip address or server name. is the that port that the Splunk receiver is listening on.

    SslAltNameToCheck string

    The alternate name to match in the remote server's SSL certificate.

    SslCertPath string

    Path to the client certificate. If specified, connection uses SSL.

    SslCipher string

    SSL Cipher in the form ALL:!aNULL:!eNULL:!LOW:!EXP:RC4+RSA:+HIGH:+MEDIUM

    SslCommonNameToCheck string

    Check the common name of the server's certificate against this name. If there is no match, assume that Splunk Enterprise is not authenticated against this server. You must specify this setting if sslVerifyServerCert is true.

    SslPassword string

    The password associated with the CAcert. The default Splunk Enterprise CAcert uses the password "password."

    SslRootCaPath string

    The path to the root certificate authority file.

    SslVerifyServerCert bool

    If true, make sure that the server you are connecting to is a valid one (authenticated). Both the common name and the alternate name of the server are then checked for a match.

    Acl OutputsTcpServerAclArgs

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

    Disabled bool

    If true, disables the group.

    Method string

    Valid values: (clone | balance | autobalance) The data distribution method used when two or more servers exist in the same forwarder group.

    Name string

    : of the Splunk receiver. can be either an ip address or server name. is the that port that the Splunk receiver is listening on.

    SslAltNameToCheck string

    The alternate name to match in the remote server's SSL certificate.

    SslCertPath string

    Path to the client certificate. If specified, connection uses SSL.

    SslCipher string

    SSL Cipher in the form ALL:!aNULL:!eNULL:!LOW:!EXP:RC4+RSA:+HIGH:+MEDIUM

    SslCommonNameToCheck string

    Check the common name of the server's certificate against this name. If there is no match, assume that Splunk Enterprise is not authenticated against this server. You must specify this setting if sslVerifyServerCert is true.

    SslPassword string

    The password associated with the CAcert. The default Splunk Enterprise CAcert uses the password "password."

    SslRootCaPath string

    The path to the root certificate authority file.

    SslVerifyServerCert bool

    If true, make sure that the server you are connecting to is a valid one (authenticated). Both the common name and the alternate name of the server are then checked for a match.

    acl OutputsTcpServerAcl

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

    disabled Boolean

    If true, disables the group.

    method String

    Valid values: (clone | balance | autobalance) The data distribution method used when two or more servers exist in the same forwarder group.

    name String

    : of the Splunk receiver. can be either an ip address or server name. is the that port that the Splunk receiver is listening on.

    sslAltNameToCheck String

    The alternate name to match in the remote server's SSL certificate.

    sslCertPath String

    Path to the client certificate. If specified, connection uses SSL.

    sslCipher String

    SSL Cipher in the form ALL:!aNULL:!eNULL:!LOW:!EXP:RC4+RSA:+HIGH:+MEDIUM

    sslCommonNameToCheck String

    Check the common name of the server's certificate against this name. If there is no match, assume that Splunk Enterprise is not authenticated against this server. You must specify this setting if sslVerifyServerCert is true.

    sslPassword String

    The password associated with the CAcert. The default Splunk Enterprise CAcert uses the password "password."

    sslRootCaPath String

    The path to the root certificate authority file.

    sslVerifyServerCert Boolean

    If true, make sure that the server you are connecting to is a valid one (authenticated). Both the common name and the alternate name of the server are then checked for a match.

    acl OutputsTcpServerAcl

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

    disabled boolean

    If true, disables the group.

    method string

    Valid values: (clone | balance | autobalance) The data distribution method used when two or more servers exist in the same forwarder group.

    name string

    : of the Splunk receiver. can be either an ip address or server name. is the that port that the Splunk receiver is listening on.

    sslAltNameToCheck string

    The alternate name to match in the remote server's SSL certificate.

    sslCertPath string

    Path to the client certificate. If specified, connection uses SSL.

    sslCipher string

    SSL Cipher in the form ALL:!aNULL:!eNULL:!LOW:!EXP:RC4+RSA:+HIGH:+MEDIUM

    sslCommonNameToCheck string

    Check the common name of the server's certificate against this name. If there is no match, assume that Splunk Enterprise is not authenticated against this server. You must specify this setting if sslVerifyServerCert is true.

    sslPassword string

    The password associated with the CAcert. The default Splunk Enterprise CAcert uses the password "password."

    sslRootCaPath string

    The path to the root certificate authority file.

    sslVerifyServerCert boolean

    If true, make sure that the server you are connecting to is a valid one (authenticated). Both the common name and the alternate name of the server are then checked for a match.

    acl OutputsTcpServerAclArgs

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

    disabled bool

    If true, disables the group.

    method str

    Valid values: (clone | balance | autobalance) The data distribution method used when two or more servers exist in the same forwarder group.

    name str

    : of the Splunk receiver. can be either an ip address or server name. is the that port that the Splunk receiver is listening on.

    ssl_alt_name_to_check str

    The alternate name to match in the remote server's SSL certificate.

    ssl_cert_path str

    Path to the client certificate. If specified, connection uses SSL.

    ssl_cipher str

    SSL Cipher in the form ALL:!aNULL:!eNULL:!LOW:!EXP:RC4+RSA:+HIGH:+MEDIUM

    ssl_common_name_to_check str

    Check the common name of the server's certificate against this name. If there is no match, assume that Splunk Enterprise is not authenticated against this server. You must specify this setting if sslVerifyServerCert is true.

    ssl_password str

    The password associated with the CAcert. The default Splunk Enterprise CAcert uses the password "password."

    ssl_root_ca_path str

    The path to the root certificate authority file.

    ssl_verify_server_cert bool

    If true, make sure that the server you are connecting to is a valid one (authenticated). Both the common name and the alternate name of the server are then checked for a match.

    acl Property Map

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

    disabled Boolean

    If true, disables the group.

    method String

    Valid values: (clone | balance | autobalance) The data distribution method used when two or more servers exist in the same forwarder group.

    name String

    : of the Splunk receiver. can be either an ip address or server name. is the that port that the Splunk receiver is listening on.

    sslAltNameToCheck String

    The alternate name to match in the remote server's SSL certificate.

    sslCertPath String

    Path to the client certificate. If specified, connection uses SSL.

    sslCipher String

    SSL Cipher in the form ALL:!aNULL:!eNULL:!LOW:!EXP:RC4+RSA:+HIGH:+MEDIUM

    sslCommonNameToCheck String

    Check the common name of the server's certificate against this name. If there is no match, assume that Splunk Enterprise is not authenticated against this server. You must specify this setting if sslVerifyServerCert is true.

    sslPassword String

    The password associated with the CAcert. The default Splunk Enterprise CAcert uses the password "password."

    sslRootCaPath String

    The path to the root certificate authority file.

    sslVerifyServerCert Boolean

    If true, make sure that the server you are connecting to is a valid one (authenticated). Both the common name and the alternate name of the server are then checked for a match.

    Supporting Types

    OutputsTcpServerAcl, OutputsTcpServerAclArgs

    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 List<String>
    removable Boolean
    sharing String
    writes List<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]
    app String
    canChangePerms Boolean
    canShareApp Boolean
    canShareGlobal Boolean
    canShareUser Boolean
    canWrite Boolean
    owner String
    reads List<String>
    removable Boolean
    sharing String
    writes List<String>

    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.4 published on Thursday, Aug 24, 2023 by Pulumi