dxl:endpoint : The Data Exchange Layer endpoint object.

The DXL endpoint object represents the settings of a particular DXL endpoint.

Object Reference

References to dxl:endpoint are object references.

The name part of the dxl:endpoint object reference has the following components:

• The name of an endpoint.

Example: dxl:endpoint/b25lLmVuZHBvaW50JDMzOQ:wintermute

Restrictions

The object does not support the following operations:

• Global search (searches via the search object)
• Scheduling
• CSV export

The object cannot be managed on Cloud Platform members.

Fields

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): disable, name, outbound_member_type.

The following fields are required to create this object:

Field	Notes
brokers	See the field description for more information
brokers_import_token	See the field description for more information
client_certificate_token
name
outbound_member_type

brokers

brokers

The list of DXL endpoint brokers. Note that you cannot specify brokers and brokers_import_token at the same time.

Type

A/An The Data Exchange Layer endpoint broker structure struct array.

Create

A brokers value is required when brokers_import_token is not defined.

Search

The field is not available for search.

brokers_import_token

brokers_import_token

The token returned by the uploadinit function call in object fileop for a DXL broker configuration file. Note that you cannot specify brokers and brokers_import_token at the same time.

Type

String.

Create

brokers_import_token is required when brokers value is not defined.

Search

The field is not available for search.

Notes

brokers_import_token is not readable.

client_certificate_subject

client_certificate_subject

The client certificate subject of a DXL endpoint.

Type

String.

Search

The field is not available for search.

Notes

The client_certificate_subject cannot be updated.

client_certificate_subject cannot be written.

client_certificate_token

client_certificate_token

The token returned by the uploadinit function call in object fileop for a DXL endpoint client certificate.

Type

String.

Create

The field is required on creation.

Search

The field is not available for search.

Notes

client_certificate_token is not readable.

client_certificate_valid_from

client_certificate_valid_from

The timestamp when client certificate for a DXL endpoint was created.

Type

Timestamp.

Search

The field is not available for search.

Notes

The client_certificate_valid_from cannot be updated.

client_certificate_valid_from cannot be written.

client_certificate_valid_to

client_certificate_valid_to

The timestamp when the client certificate for a DXL endpoint expires.

Type

Timestamp.

Search

The field is not available for search.

Notes

The client_certificate_valid_to cannot be updated.

client_certificate_valid_to cannot be written.

comment

comment

The comment of a DXL endpoint.

Type

String.

Create

The default value is empty.

Search

The field is not available for search.

disable

disable

Determines whether a DXL endpoint is disabled.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

Notes

The disable is part of the base object.

extattrs

extattrs

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.

log_level

log_level

The log level for a DXL endpoint.

Type

String.

Valid values are:

• DEBUG
• ERROR
• INFO
• WARNING

Create

The default value is WARNING.

Search

The field is available for search via

• ‘=’ (exact equality)

name

name

The name of a DXL 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

• ‘:=’ (case insensitive search)
• ‘=’ (exact equality)
• ‘~=’ (regular expression)

Notes

The name is part of the base object.

outbound_member_type

outbound_member_type

The outbound member that will generate events.

Type

String.

Valid values are:

• GM
• MEMBER

Create

The field is required on creation.

Search

The field is available for search via

• ‘=’ (exact equality)

Notes

The outbound_member_type is part of the base object.

outbound_members

outbound_members

The list of members for outbound events.

Type

String array.

Create

The default value is empty.

Search

The field is not available for search.

template_instance

template_instance

The DXL template instance. You cannot change the parameters of the DXL 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.

timeout

timeout

The timeout of session management (in seconds).

Type

Unsigned integer.

Create

The default value is 30.

Search

The field is not available for search.

topics

topics

DXL topics

Type

String array.

Create

The default value is empty.

Search

The field is not available for search.

vendor_identifier

vendor_identifier

The vendor identifier.

Type

String.

Create

The default value is empty.

Search

The field is available for search via

• ‘:=’ (case insensitive search)
• ‘=’ (exact equality)
• ‘~=’ (regular expression)

wapi_user_name

wapi_user_name

The user name for WAPI integration.

Type

String.

Create

The default value is empty.

Search

The field is not available for search.

wapi_user_password

wapi_user_password

The user password for WAPI integration.

Type

String.

Create

The default value is undefined.

Search

The field is not available for search.

Notes

wapi_user_password is not readable.

Function Calls

clear_outbound_worker_log

Use this function to clear the outbound worker log for the endpoint.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

None

Output fields

error_message ( String. ) The error message.

overall_status ( String. Valid values are: “FAILED”, “SUCCESS” ) The overall status of clearing procedure.

test_broker_connectivity

Use this function to test the DXL endpoint broker connectivity.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

broker ( A/An The Data Exchange Layer endpoint broker structure struct. ). This parameter is mandatory. The DXL endpoint broker that is the subject for the connectivity test.

client_certificate_token ( String. ) The token returned by the uploadinit function call in object fileop for a DXL endpoint client certificate.

endpoint ( String. ) The DXL Endpoint name.

Output fields

error_message ( String. ) The test connectivity failed error message.

overall_status ( String. Valid values are: “FAILED”, “SUCCESS” ) The overall status of the connectivity test.

Fields List

Field	Type	Req	R/O	Base	Search
brokers	[struct]	Y*	N	N	N/A
brokers_import_token	String	Y*	N	N	N/A
client_certificate_subject	String	N	Y	N	N/A
client_certificate_token	String	Y	N	N	N/A
client_certificate_valid_from	Timestamp	N	Y	N	N/A
client_certificate_valid_to	Timestamp	N	Y	N	N/A
comment	String	N	N	N	N/A
disable	Bool	N	N	Y	N/A
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
template_instance	struct	N	N	N	N/A
timeout	Unsigned int	N	N	N	N/A
topics	[String]	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

* Required in some cases, see detailed field description above.