The name part of the syslog:endpoint object reference has the following components:
- The name of an endpoint.
Example: syslog:endpoint/b25lLmVuZHBvaW50JDMzOQ:wintermute
References to syslog:endpoint are object references.
The object does not support the following operations:
The object cannot be managed on Cloud Platform members.
These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.
The basic version of the object contains the field(s): name, outbound_member_type.
The following fields are required to create this object:
| Field | Notes |
|---|---|
| name | |
| outbound_member_type |
Extensible attributes associated with the object.
For valid values for extensible attributes, see the following information.
Type
Extensible attributes.
This field allows +/- to be specified as part of the field name when updating the object, see the following information.
Create
The default value is empty.
Search
For how to search extensible attributes, see the following information.
The log level for a notification REST endpoint.
Type
String.
Create
The default value is WARNING.
Search
The field is available for search via
The name of a Syslog endpoint.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The field is required on creation.
Search
The field is available for search via
Notes
The name is part of the base object.
The outbound member that will generate events.
Type
String.
Create
The field is required on creation.
Search
The field is available for search via
Notes
The outbound_member_type is part of the base object.
The list of members for outbound events.
Type
String array.
Create
The default value is empty.
Search
The field is not available for search.
List of syslog servers
Type
A/An Syslog server structure struct array.
Create
The default value is:
empty
Search
The field is not available for search.
The Syslog template instance. You cannot change the parameters of the Syslog endpoint template instance.
Type
A/An Notification REST template instance struct.
Create
The default value is empty.
Search
The field is not available for search.
The timeout of session management (in seconds).
Type
Unsigned integer.
Create
The default value is 30.
Search
The field is not available for search.
The vendor identifier.
Type
String.
Create
The default value is empty.
Search
The field is available for search via
Function to test a connection to the syslog endpoint server.
This function does not support multiple object matches when called as part of an atomic insertion operation.
Input fields
syslog_server ( A/An Syslog server structure struct. ). This parameter is mandatory. The syslog server for testing the connection.
Output fields
result ( String. Valid values are: “CANNOT_CONNECT”, “TEST_OK”, “CERTIFICATE_IS_NOT_VALID” ) The result of connection testing to the endpoint syslog server.
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| extattrs | Extattr | N | N | N | ext |
| log_level | String | N | N | N | = |
| name | String | Y | N | Y | : = ~ |
| outbound_member_type | String | Y | N | Y | = |
| outbound_members | [String] | N | N | N | N/A |
| syslog_servers | [struct] | N | N | N | N/A |
| template_instance | struct | N | N | N | N/A |
| timeout | Unsigned int | N | N | N | N/A |
| vendor_identifier | String | N | N | N | : = ~ |
| wapi_user_name | String | N | N | N | N/A |
| wapi_user_password | String | N | N | N | N/A |
