---
title: Syslog
description: Resource path:
component: pingam
version: 8.1
page_id: pingam:entity-reference:sec-amster-entity-syslog
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-syslog.html
section_ids:
sec-amster-entity-syslog-realm-ops: Realm Operations
sec-amster-entity-syslog-realm-ops-create: create
sec-amster-entity-syslog-realm-ops-delete: delete
sec-amster-entity-syslog-realm-ops-getalltypes: getAllTypes
sec-amster-entity-syslog-realm-ops-getcreatabletypes: getCreatableTypes
sec-amster-entity-syslog-realm-ops-nextdescendents: nextdescendents
sec-amster-entity-syslog-realm-ops-query: query
sec-amster-entity-syslog-realm-ops-read: read
sec-amster-entity-syslog-realm-ops-update: update
sec-amster-entity-syslog-global-ops: Global Operations
sec-amster-entity-syslog-global-ops-create: create
sec-amster-entity-syslog-global-ops-delete: delete
sec-amster-entity-syslog-global-ops-getalltypes: getAllTypes
sec-amster-entity-syslog-global-ops-getcreatabletypes: getCreatableTypes
sec-amster-entity-syslog-global-ops-nextdescendents: nextdescendents
sec-amster-entity-syslog-global-ops-query: query
sec-amster-entity-syslog-global-ops-read: read
sec-amster-entity-syslog-global-ops-update: update
---
# Syslog
## Realm Operations
Resource path:
```
/realm-config/services/audit/Syslog
```
Resource version: `0.0`
### create
**Usage**
```
am> create Syslog --realm Realm --id id --body body
```
**Parameters**
* *\--id*
The unique identifier for the resource.
* *\--body*
The resource in JSON format, described by the following JSON schema:
```json
{
"type" : "object",
"properties" : {
"commonHandler" : {
"type" : "object",
"title" : "General Handler Configuration",
"propertyOrder" : 0,
"properties" : {
"topics" : {
"title" : "Topics",
"description" : "List of topics handled by an audit event handler.",
"propertyOrder" : 2300,
"required" : true,
"items" : {
"type" : "string"
},
"type" : "array",
"exampleValue" : ""
},
"enabled" : {
"title" : "Enabled",
"description" : "Enables or disables an audit event handler.",
"propertyOrder" : 2200,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
}
}
},
"commonHandlerPlugin" : {
"type" : "object",
"title" : "Audit Event Handler Factory",
"propertyOrder" : 1,
"properties" : {
"handlerFactory" : {
"title" : "Factory Class Name",
"description" : "The fully qualified class name of the factory responsible for creating the Audit Event Handler. The class must implement org.forgerock.openam.audit.AuditEventHandlerFactory.",
"propertyOrder" : 3000,
"required" : true,
"type" : "string",
"exampleValue" : ""
}
}
},
"sysLogConfig" : {
"type" : "object",
"title" : "Syslog Configuration",
"propertyOrder" : 2,
"properties" : {
"transportProtocol" : {
"title" : "Transport Protocol",
"description" : "",
"propertyOrder" : 2600,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"connectTimeout" : {
"title" : "Connection timeout",
"description" : "Timeout for connecting to syslog server, in seconds.",
"propertyOrder" : 2700,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"host" : {
"title" : "Server hostname",
"description" : "Host name or IP address of receiving syslog server.",
"propertyOrder" : 2400,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"port" : {
"title" : "Server port",
"description" : "Port number of receiving syslog server.",
"propertyOrder" : 2500,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"facility" : {
"title" : "Facility",
"description" : "Syslog facility value to apply to all events.",
"propertyOrder" : 2800,
"required" : true,
"type" : "string",
"exampleValue" : ""
}
}
},
"sysLogBuffering" : {
"type" : "object",
"title" : "Buffering",
"propertyOrder" : 3,
"properties" : {
"bufferingEnabled" : {
"title" : "Buffering Enabled",
"description" : "Enables or disables audit event buffering.",
"propertyOrder" : 2900,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
},
"bufferingMaxSize" : {
"title" : "Buffer Size",
"description" : "Maximum number of events that can be buffered (default/minimum: 5000)",
"propertyOrder" : 2950,
"required" : true,
"type" : "string",
"exampleValue" : ""
}
}
}
}
}
```
### delete
**Usage**
```
am> delete Syslog --realm Realm --id id
```
**Parameters**
* *\--id*
The unique identifier for the resource.
### getAllTypes
Obtain the collection of all secondary configuration types related to the resource.
**Usage**
```
am> action Syslog --realm Realm --actionName getAllTypes
```
### getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
**Usage**
```
am> action Syslog --realm Realm --actionName getCreatableTypes
```
### nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
**Usage**
```
am> action Syslog --realm Realm --actionName nextdescendents
```
### query
Get the full list of instances of this collection. This query only supports `_queryFilter=true` filter.
**Usage**
```
am> query Syslog --realm Realm --filter filter
```
**Parameters**
* *\--filter*
A CREST formatted query filter, where "true" will query all.
### read
**Usage**
```
am> read Syslog --realm Realm --id id
```
**Parameters**
* *\--id*
The unique identifier for the resource.
### update
**Usage**
```
am> update Syslog --realm Realm --id id --body body
```
**Parameters**
* *\--id*
The unique identifier for the resource.
* *\--body*
The resource in JSON format, described by the following JSON schema:
```json
{
"type" : "object",
"properties" : {
"commonHandler" : {
"type" : "object",
"title" : "General Handler Configuration",
"propertyOrder" : 0,
"properties" : {
"topics" : {
"title" : "Topics",
"description" : "List of topics handled by an audit event handler.",
"propertyOrder" : 2300,
"required" : true,
"items" : {
"type" : "string"
},
"type" : "array",
"exampleValue" : ""
},
"enabled" : {
"title" : "Enabled",
"description" : "Enables or disables an audit event handler.",
"propertyOrder" : 2200,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
}
}
},
"commonHandlerPlugin" : {
"type" : "object",
"title" : "Audit Event Handler Factory",
"propertyOrder" : 1,
"properties" : {
"handlerFactory" : {
"title" : "Factory Class Name",
"description" : "The fully qualified class name of the factory responsible for creating the Audit Event Handler. The class must implement org.forgerock.openam.audit.AuditEventHandlerFactory.",
"propertyOrder" : 3000,
"required" : true,
"type" : "string",
"exampleValue" : ""
}
}
},
"sysLogConfig" : {
"type" : "object",
"title" : "Syslog Configuration",
"propertyOrder" : 2,
"properties" : {
"transportProtocol" : {
"title" : "Transport Protocol",
"description" : "",
"propertyOrder" : 2600,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"connectTimeout" : {
"title" : "Connection timeout",
"description" : "Timeout for connecting to syslog server, in seconds.",
"propertyOrder" : 2700,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"host" : {
"title" : "Server hostname",
"description" : "Host name or IP address of receiving syslog server.",
"propertyOrder" : 2400,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"port" : {
"title" : "Server port",
"description" : "Port number of receiving syslog server.",
"propertyOrder" : 2500,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"facility" : {
"title" : "Facility",
"description" : "Syslog facility value to apply to all events.",
"propertyOrder" : 2800,
"required" : true,
"type" : "string",
"exampleValue" : ""
}
}
},
"sysLogBuffering" : {
"type" : "object",
"title" : "Buffering",
"propertyOrder" : 3,
"properties" : {
"bufferingEnabled" : {
"title" : "Buffering Enabled",
"description" : "Enables or disables audit event buffering.",
"propertyOrder" : 2900,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
},
"bufferingMaxSize" : {
"title" : "Buffer Size",
"description" : "Maximum number of events that can be buffered (default/minimum: 5000)",
"propertyOrder" : 2950,
"required" : true,
"type" : "string",
"exampleValue" : ""
}
}
}
}
}
```
## Global Operations
Resource path:
```
/global-config/services/audit/Syslog
```
Resource version: `1.0`
### create
**Usage**
```
am> create Syslog --global --id id --body body
```
**Parameters**
* *\--id*
The unique identifier for the resource.
* *\--body*
The resource in JSON format, described by the following JSON schema:
```json
{
"type" : "object",
"properties" : {
"sysLogConfig" : {
"type" : "object",
"title" : "Syslog Configuration",
"propertyOrder" : 2,
"properties" : {
"transportProtocol" : {
"title" : "Transport Protocol",
"description" : "",
"propertyOrder" : 2600,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"port" : {
"title" : "Server port",
"description" : "Port number of receiving syslog server.",
"propertyOrder" : 2500,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"facility" : {
"title" : "Facility",
"description" : "Syslog facility value to apply to all events.",
"propertyOrder" : 2800,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"host" : {
"title" : "Server hostname",
"description" : "Host name or IP address of receiving syslog server.",
"propertyOrder" : 2400,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"connectTimeout" : {
"title" : "Connection timeout",
"description" : "Timeout for connecting to syslog server, in seconds.",
"propertyOrder" : 2700,
"required" : true,
"type" : "string",
"exampleValue" : ""
}
}
},
"commonHandler" : {
"type" : "object",
"title" : "General Handler Configuration",
"propertyOrder" : 0,
"properties" : {
"topics" : {
"title" : "Topics",
"description" : "List of topics handled by an audit event handler.",
"propertyOrder" : 2300,
"required" : true,
"items" : {
"type" : "string"
},
"type" : "array",
"exampleValue" : ""
},
"enabled" : {
"title" : "Enabled",
"description" : "Enables or disables an audit event handler.",
"propertyOrder" : 2200,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
}
}
},
"sysLogBuffering" : {
"type" : "object",
"title" : "Buffering",
"propertyOrder" : 3,
"properties" : {
"bufferingMaxSize" : {
"title" : "Buffer Size",
"description" : "Maximum number of events that can be buffered (default/minimum: 5000)",
"propertyOrder" : 2950,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"bufferingEnabled" : {
"title" : "Buffering Enabled",
"description" : "Enables or disables audit event buffering.",
"propertyOrder" : 2900,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
}
}
},
"commonHandlerPlugin" : {
"type" : "object",
"title" : "Audit Event Handler Factory",
"propertyOrder" : 1,
"properties" : {
"handlerFactory" : {
"title" : "Factory Class Name",
"description" : "The fully qualified class name of the factory responsible for creating the Audit Event Handler. The class must implement org.forgerock.openam.audit.AuditEventHandlerFactory.",
"propertyOrder" : 3000,
"required" : true,
"type" : "string",
"exampleValue" : ""
}
}
}
}
}
```
### delete
**Usage**
```
am> delete Syslog --global --id id
```
**Parameters**
* *\--id*
The unique identifier for the resource.
### getAllTypes
Obtain the collection of all secondary configuration types related to the resource.
**Usage**
```
am> action Syslog --global --actionName getAllTypes
```
### getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
**Usage**
```
am> action Syslog --global --actionName getCreatableTypes
```
### nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
**Usage**
```
am> action Syslog --global --actionName nextdescendents
```
### query
Get the full list of instances of this collection. This query only supports `_queryFilter=true` filter.
**Usage**
```
am> query Syslog --global --filter filter
```
**Parameters**
* *\--filter*
A CREST formatted query filter, where "true" will query all.
### read
**Usage**
```
am> read Syslog --global --id id
```
**Parameters**
* *\--id*
The unique identifier for the resource.
### update
**Usage**
```
am> update Syslog --global --id id --body body
```
**Parameters**
* *\--id*
The unique identifier for the resource.
* *\--body*
The resource in JSON format, described by the following JSON schema:
```json
{
"type" : "object",
"properties" : {
"sysLogConfig" : {
"type" : "object",
"title" : "Syslog Configuration",
"propertyOrder" : 2,
"properties" : {
"transportProtocol" : {
"title" : "Transport Protocol",
"description" : "",
"propertyOrder" : 2600,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"port" : {
"title" : "Server port",
"description" : "Port number of receiving syslog server.",
"propertyOrder" : 2500,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"facility" : {
"title" : "Facility",
"description" : "Syslog facility value to apply to all events.",
"propertyOrder" : 2800,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"host" : {
"title" : "Server hostname",
"description" : "Host name or IP address of receiving syslog server.",
"propertyOrder" : 2400,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"connectTimeout" : {
"title" : "Connection timeout",
"description" : "Timeout for connecting to syslog server, in seconds.",
"propertyOrder" : 2700,
"required" : true,
"type" : "string",
"exampleValue" : ""
}
}
},
"commonHandler" : {
"type" : "object",
"title" : "General Handler Configuration",
"propertyOrder" : 0,
"properties" : {
"topics" : {
"title" : "Topics",
"description" : "List of topics handled by an audit event handler.",
"propertyOrder" : 2300,
"required" : true,
"items" : {
"type" : "string"
},
"type" : "array",
"exampleValue" : ""
},
"enabled" : {
"title" : "Enabled",
"description" : "Enables or disables an audit event handler.",
"propertyOrder" : 2200,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
}
}
},
"sysLogBuffering" : {
"type" : "object",
"title" : "Buffering",
"propertyOrder" : 3,
"properties" : {
"bufferingMaxSize" : {
"title" : "Buffer Size",
"description" : "Maximum number of events that can be buffered (default/minimum: 5000)",
"propertyOrder" : 2950,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"bufferingEnabled" : {
"title" : "Buffering Enabled",
"description" : "Enables or disables audit event buffering.",
"propertyOrder" : 2900,
"required" : true,
"type" : "boolean",
"exampleValue" : ""
}
}
},
"commonHandlerPlugin" : {
"type" : "object",
"title" : "Audit Event Handler Factory",
"propertyOrder" : 1,
"properties" : {
"handlerFactory" : {
"title" : "Factory Class Name",
"description" : "The fully qualified class name of the factory responsible for creating the Audit Event Handler. The class must implement org.forgerock.openam.audit.AuditEventHandlerFactory.",
"propertyOrder" : 3000,
"required" : true,
"type" : "string",
"exampleValue" : ""
}
}
}
}
}
```