Management API Reference for protocol=tcp

Configuration to append to syslog over tcp/ip.

Attributes (4)

host - The host of the syslog server for the tcp requests.

Type	STRING
Default Value	localhost
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The host of the syslog server for the tcp requests.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "localhost", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

message-transfer - The message transfer setting as described in section 3.4 of RFC-6587. This can either be OCTET_COUNTING as described in section 3.4.1 of RFC-6587, or NON_TRANSPARENT_FRAMING as described in section 3.4.1 of RFC-6587. See your syslog provider's documentation for what is supported.

Type	STRING
Default Value	NON_TRANSPARENT_FRAMING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The message transfer setting as described in section 3.4 of RFC-6587. This can either be OCTET_COUNTING as described in section 3.4.1 of RFC-6587, or NON_TRANSPARENT_FRAMING as described in section 3.4.1 of RFC-6587. See your syslog provider's documentation for what is supported.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "NON_TRANSPARENT_FRAMING", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

port - The port of the syslog server for the tcp requests.

Type	INT
Default Value	514
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The port of the syslog server for the tcp requests.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 514, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

reconnect-timeout - If a connection drop is detected, the number of seconds to wait before reconnecting. A negative number means don't reconnect automatically.

Type	INT
Default Value	-1
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "If a connection drop is detected, the number of seconds to wait before reconnecting. A negative number means don't reconnect automatically.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : -1, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

Operations (2)

add - Add the syslog tcp protocol.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
host	STRING	false	true	localhost	The host of the syslog server for the tcp requests.
message-transfer	STRING	false	true	NON_TRANSPARENT_FRAMING	The message transfer setting as described in section 3.4 of RFC-6587. This can either be OCTET_COUNTING as described in section 3.4.1 of RFC-6587, or NON_TRANSPARENT_FRAMING as described in section 3.4.1 of RFC-6587. See your syslog provider's documentation for what is supported.
port	INT	false	true	514	The port of the syslog server for the tcp requests.
reconnect-timeout	INT	false	true	-1	If a connection drop is detected, the number of seconds to wait before reconnecting. A negative number means don't reconnect automatically.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add the syslog tcp protocol.",
    "request-properties" : {
        "host" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The host of the syslog server for the tcp requests.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "localhost",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "message-transfer" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The message transfer setting as described in section 3.4 of RFC-6587. This can either be OCTET_COUNTING as described in section 3.4.1 of RFC-6587, or NON_TRANSPARENT_FRAMING as described in section 3.4.1 of RFC-6587. See your syslog provider's documentation for what is supported.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "NON_TRANSPARENT_FRAMING",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "port" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The port of the syslog server for the tcp requests.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 514,
            "stability" : "default"
        },
        "reconnect-timeout" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "If a connection drop is detected, the number of seconds to wait before reconnecting. A negative number means don't reconnect automatically.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : -1,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Remove the syslog tcp protocol.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove the syslog tcp protocol.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

core-service.management.access.audit.syslog-handler.protocol.tcp

        
<feature spec="core-service.management.access.audit.syslog-handler.protocol.tcp">
  <param name="syslog-handler" value="{resource name}"/>
  <param name="host-feature" value="{value}"/>
  <param name="message-transfer" value="{value}"/>
  <param name="port" value="{value}"/>
  <param name="reconnect-timeout" value="{value}"/>
<feature/>