## Children (1)

- protocol
  - tcp
  - tls
  - udp

## Attributes (9)

- app-name - The application name to add to the syslog records as defined in section 6.2.5 of RFC-5424. If not specified it will default to the name of the product.

  Type | STRING
  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 application name to add to the syslog records as defined in section 6.2.5 of RFC-5424. If not specified it will default to the name of the product.",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "min-length" : 1,
          "max-length" : 2147483647,
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "no-services",
          "capability-reference" : null
      }

- disabled-due-to-failure - Whether this handler has been disabled due to logging failures.

  Type | BOOLEAN
  Where is the attribute stored? | runtime
  Access Type | read-only
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "BOOLEAN"
          },
          "description" : "Whether this handler has been disabled due to logging failures.",
          "expressions-allowed" : false,
          "required" : true,
          "nillable" : false,
          "stability" : "default",
          "access-type" : "read-only",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- facility - The facility to use for syslog logging as defined in section 6.2.1 of RFC-5424, and section 4.1.1 of RFC-3164.

  Type | STRING
  Default Value | USER_LEVEL
  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
  Allowed Values | LOG_AUDIT LOCAL_USE_6 LOCAL_USE_7 SECURITY2 LOCAL_USE_4 LOCAL_USE_5 LOCAL_USE_2 CLOCK_DAEMON LOCAL_USE_3 UUCP LOCAL_USE_0 NTP LOCAL_USE_1 CLOCK_DAEMON2 LINE_PRINTER NETWORK_NEWS KERNEL SYSTEM_DAEMONS SYSLOGD FTP_DAEMON SECURITY MAIL_SYSTEM LOG_ALERT USER_LEVEL
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "STRING"
          },
          "description" : "The facility to use for syslog logging as defined in section 6.2.1 of RFC-5424, and section 4.1.1 of RFC-3164.",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "default" : "USER_LEVEL",
          "allowed" : [
              "KERNEL",
              "USER_LEVEL",
              "MAIL_SYSTEM",
              "SYSTEM_DAEMONS",
              "SECURITY",
              "SYSLOGD",
              "LINE_PRINTER",
              "NETWORK_NEWS",
              "UUCP",
              "CLOCK_DAEMON",
              "SECURITY2",
              "FTP_DAEMON",
              "NTP",
              "LOG_AUDIT",
              "LOG_ALERT",
              "CLOCK_DAEMON2",
              "LOCAL_USE_0",
              "LOCAL_USE_1",
              "LOCAL_USE_2",
              "LOCAL_USE_3",
              "LOCAL_USE_4",
              "LOCAL_USE_5",
              "LOCAL_USE_6",
              "LOCAL_USE_7"
          ],
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "no-services",
          "capability-reference" : null
      }

- failure-count - The number of logging failures since the handler was initialized.

  Type | INT
  Where is the attribute stored? | runtime
  Access Type | read-only
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "INT"
          },
          "description" : "The number of logging failures since the handler was initialized.",
          "expressions-allowed" : false,
          "required" : true,
          "nillable" : false,
          "stability" : "default",
          "access-type" : "read-only",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- formatter - The formatter used to format the log messages.

  Type | STRING
  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 formatter used to format the log messages.",
          "expressions-allowed" : false,
          "required" : true,
          "nillable" : false,
          "min-length" : 1,
          "max-length" : 2147483647,
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "no-services",
          "capability-reference" : null
      }

- max-failure-count - The maximum number of logging failures before disabling this handler.

  Type | INT
  Default Value | 10
  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
  Min | 0
  Max | 2147483647
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "INT"
          },
          "description" : "The maximum number of logging failures before disabling this handler.",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "default" : 10,
          "min" : 0,
          "max" : 2147483647,
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "no-services",
          "capability-reference" : null
      }

- max-length - The maximum length in bytes a log message, including the header, is allowed to be. If undefined, it will default to 1024 bytes if the syslog-format is RFC3164, or 2048 bytes if the syslog-format is RFC5424.

  Type | INT
  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 maximum length in bytes a log message, including the header, is allowed to be. If undefined, it will default to 1024 bytes if the syslog-format is RFC3164, or 2048 bytes if the syslog-format is RFC5424.",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "no-services",
          "capability-reference" : null
      }

- syslog-format - Whether to set the syslog format to the one specified in RFC-5424 or RFC-3164.

  Type | STRING
  Default Value | RFC5424
  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
  Allowed Values | RFC3164 RFC5424
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "STRING"
          },
          "description" : "Whether to set the syslog format to the one specified in RFC-5424 or RFC-3164.",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "default" : "RFC5424",
          "allowed" : [
              "RFC5424",
              "RFC3164"
          ],
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "no-services",
          "capability-reference" : null
      }

- truncate - Whether or not a message, including the header, should truncate the message if the length in bytes is greater than the maximum length. If set to false messages will be split and sent with the same header values.

  Type | BOOLEAN
  Default Value | false
  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" : "BOOLEAN"
          },
          "description" : "Whether or not a message, including the header, should truncate the message if the length in bytes is greater than the maximum length. If set to false messages will be split and sent with the same header values.",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "default" : false,
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "no-services",
          "capability-reference" : null
      }

## Operations (3)

- add - Adds an audit log syslog handler.

  Request Parameter | Type | Required | Expressions Allowed | Default value | Description
  --- | --- | --- | --- | --- | ---
  app-name | STRING | false | true |  | The application name to add to the syslog records as defined in section 6.2.5 of RFC-5424. If not specified it will default to the name of the product.
  facility | STRING | false | true | USER_LEVEL | The facility to use for syslog logging as defined in section 6.2.1 of RFC-5424, and section 4.1.1 of RFC-3164.
  formatter | STRING | true | false |  | The formatter used to format the log messages.
  max-failure-count | INT | false | true | 10 | The maximum number of logging failures before disabling this handler.
  max-length | INT | false | true |  | The maximum length in bytes a log message, including the header, is allowed to be. If undefined, it will default to 1024 bytes if the syslog-format is RFC3164, or 2048 bytes if the syslog-format is RFC5424.
  syslog-format | STRING | false | true | RFC5424 | Whether to set the syslog format to the one specified in RFC-5424 or RFC-3164.
  truncate | BOOLEAN | false | true | false | Whether or not a message, including the header, should truncate the message if the length in bytes is greater than the maximum length. If set to false messages will be split and sent with the same header values.

  Raw DMR model |
      {
          "operation-name" : "add",
          "description" : "Adds an audit log syslog handler.",
          "request-properties" : {
              "app-name" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The application name to add to the syslog records as defined in section 6.2.5 of RFC-5424. If not specified it will default to the name of the product.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "facility" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The facility to use for syslog logging as defined in section 6.2.1 of RFC-5424, and section 4.1.1 of RFC-3164.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "default" : "USER_LEVEL",
                  "allowed" : [
                      "KERNEL",
                      "USER_LEVEL",
                      "MAIL_SYSTEM",
                      "SYSTEM_DAEMONS",
                      "SECURITY",
                      "SYSLOGD",
                      "LINE_PRINTER",
                      "NETWORK_NEWS",
                      "UUCP",
                      "CLOCK_DAEMON",
                      "SECURITY2",
                      "FTP_DAEMON",
                      "NTP",
                      "LOG_AUDIT",
                      "LOG_ALERT",
                      "CLOCK_DAEMON2",
                      "LOCAL_USE_0",
                      "LOCAL_USE_1",
                      "LOCAL_USE_2",
                      "LOCAL_USE_3",
                      "LOCAL_USE_4",
                      "LOCAL_USE_5",
                      "LOCAL_USE_6",
                      "LOCAL_USE_7"
                  ],
                  "stability" : "default"
              },
              "formatter" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The formatter used to format the log messages.",
                  "expressions-allowed" : false,
                  "required" : true,
                  "nillable" : false,
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "max-failure-count" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "INT"
                  },
                  "description" : "The maximum number of logging failures before disabling this handler.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "default" : 10,
                  "min" : 0,
                  "max" : 2147483647,
                  "stability" : "default"
              },
              "max-length" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "INT"
                  },
                  "description" : "The maximum length in bytes a log message, including the header, is allowed to be. If undefined, it will default to 1024 bytes if the syslog-format is RFC3164, or 2048 bytes if the syslog-format is RFC5424.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "stability" : "default"
              },
              "syslog-format" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "Whether to set the syslog format to the one specified in RFC-5424 or RFC-3164.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "default" : "RFC5424",
                  "allowed" : [
                      "RFC5424",
                      "RFC3164"
                  ],
                  "stability" : "default"
              },
              "truncate" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "BOOLEAN"
                  },
                  "description" : "Whether or not a message, including the header, should truncate the message if the length in bytes is greater than the maximum length. If set to false messages will be split and sent with the same header values.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "default" : false,
                  "stability" : "default"
              }
          },
          "reply-properties" : {},
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : false
      }

- recycle - Resets the syslog handler failure count, disconnects and reconnects to the syslog server.

  Raw DMR model |
      {
          "operation-name" : "recycle",
          "description" : "Resets the syslog handler failure count, disconnects and reconnects to the syslog server.",
          "request-properties" : {},
          "reply-properties" : {},
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : true
      }

- remove - Removes an audit log syslog handler.

  Raw DMR model |
      {
          "operation-name" : "remove",
          "description" : "Removes an audit log syslog handler.",
          "request-properties" : {},
          "reply-properties" : {},
          "stability" : "default",
          "read-only" : false,
          "restart-required" : "all-services",
          "runtime-only" : false
      }

## Galleon Features

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

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

      <feature spec="core-service.management.access.audit.syslog-handler">
        <param name="syslog-handler" value="{resource name}"/>
        <param name="app-name" value="{value}"/>
        <param name="facility" value="{value}"/>
        <param name="formatter" value="{value}"/>
        <param name="max-failure-count" value="{value}"/>
        <param name="max-length" value="{value}"/>
        <param name="syslog-format" value="{value}"/>
        <param name="truncate" value="{value}"/>
      <feature/>