Syslog External Servers may be used to communicate with syslog servers over UDP or TCP.
The Syslog External Server component inherits from the External Server
The following components have a direct aggregation relation from Syslog External Servers:
The following components have a direct aggregation relation to Syslog External Servers:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| description | None |
| server-host-name | |
| server-port | |
| transport-mechanism | |
| connect-timeout | |
| max-connection-age | |
| trust-manager-provider |
| Description | A description for this External Server |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The address of the syslog server. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The port on which the syslog server accepts connections. If this is not provided, then a default port will be chosen based on the transport mechanism. Port 514 will be used by default when communicating over unencrypted UDP or unencrypted TCP. Port 6514 will be used by default when communicating over TCP that is encrypted with TLS. |
| Default Value | A default port will be chosen based on the transport mechanism. |
| Allowed Values | An integer value. Lower limit is 1. Upper limit is 65535 . |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
transport-mechanism (Read-Only)
| Description | The transport mechanism that should be used when communicating with the syslog server. |
| Default Value | None |
| Allowed Values | unencrypted-udp - Indicates that communication with the syslog server should occur over unencrypted UDP. unencrypted-tcp - Indicates that communication with the syslog server should occur over unencrypted TCP. tls-encrypted-tcp - Indicates that communication with the syslog server should occur over TCP with TLS encryption. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the maximum length of time to wait for a connection to be established before giving up and considering the server unavailable. This will only be used when communicating with the syslog server over TCP (with or without TLS encryption). A value of zero seconds indicates that no connect timeout should be enforced, although the network stack of the underlying operating system may enforce a limit. |
| Default Value | 2 seconds |
| Allowed Values | A duration. Lower limit is 0 milliseconds. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The maximum length of time that TCP connections should remain established. This will be ignored for UDP-based connections. A zero duration indicates that no maximum age will be imposed. |
| Default Value | 10 minutes |
| Allowed Values | A duration. Lower limit is 0 milliseconds. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | A trust manager provider that will be used to determine whether to trust the certificate chain presented by the syslog server when communication is encrypted with TLS. This property will be ignored when not using TLS encryption. |
| Default Value | JVM-Default |
| Allowed Values | The DN of any Trust Manager Provider. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
To list the configured External Servers:
dsconfig list-external-servers
[--property {propertyName}] ...
To view the configuration for an existing External Server:
dsconfig get-external-server-prop
--server-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing External Server:
dsconfig set-external-server-prop
--server-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Syslog External Server:
dsconfig create-external-server
--server-name {name}
--type syslog
--set server-host-name:{propertyValue}
--set transport-mechanism:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing External Server:
dsconfig delete-external-server
--server-name {name}