ciscoise:endpoint : Cisco ISE Endpoint object.

The object contains information and configuration for third-party Cisco ISE servers integration, configuration for Cisco ISE publishing and subscription.

Object Reference

References to ciscoise:endpoint are object references.

The name part of a Cisco ISE endpoint reference has the following components:

  • address of the Cisco ISE endpoint

Example: ciscoise:endpoint/ZG5zLm5ldHdvcmtfdmlldyQxMTk:10.0.0.10

Restrictions

The object does not support the following operations:

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): address, disable, resolved_address, type, version.

The following fields are required to create this object:

Field Notes
address  
bulk_download_certificate_token  
client_certificate_token  
subscribe_settings  
subscribing_member  
version  

address

address

The Cisco ISE endpoint IPv4 Address or IPv6 Address or Fully-Qualified Domain Name (FQDN)

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 address is part of the base object.

bulk_download_certificate_subject

bulk_download_certificate_subject

The Cisco ISE bulk download certificate subject.

Type

String.

Search

The field is not available for search.

Notes

The bulk_download_certificate_subject cannot be updated.

bulk_download_certificate_subject cannot be written.

bulk_download_certificate_token

bulk_download_certificate_token

The token returned by the uploadinit function call in object fileop for Cisco ISE bulk download certificate.

Type

String.

Create

The field is required on creation.

Search

The field is not available for search.

Notes

bulk_download_certificate_token is not readable.

bulk_download_certificate_valid_from

bulk_download_certificate_valid_from

The Cisco ISE bulk download certificate valid from.

Type

Timestamp.

Search

The field is not available for search.

Notes

The bulk_download_certificate_valid_from cannot be updated.

bulk_download_certificate_valid_from cannot be written.

bulk_download_certificate_valid_to

bulk_download_certificate_valid_to

The Cisco ISE bulk download certificate valid to.

Type

Timestamp.

Search

The field is not available for search.

Notes

The bulk_download_certificate_valid_to cannot be updated.

bulk_download_certificate_valid_to cannot be written.

client_certificate_subject

client_certificate_subject

The Cisco ISE client certificate subject.

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 Cisco ISE 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 Cisco ISE client certificate valid from.

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 Cisco ISE client certificate valid to.

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 Cisco ISE endpoint descriptive comment.

Type

String.

Create

The default value is empty.

Search

The field is available for search via

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

connection_status

connection_status

The Cisco ISE connection status.

Type

String.

Search

The field is not available for search.

Notes

The connection_status cannot be updated.

connection_status cannot be written.

connection_timeout

connection_timeout

The Cisco ISE connection timeout.

Type

Unsigned integer.

Create

The default value is 10.

Search

The field is not available for search.

disable

disable

Determines whether a Cisco ISE endpoint is disabled or not. When this is set to False, the Cisco ISE endpoint is enabled.

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.

network_view

network_view

The Cisco ISE network view name.

Type

String.

Create

The default value is undefined.

Search

The field is available for search via

  • ‘=’ (exact equality)

publish_settings

publish_settings

The Cisco ISE publish settings.

Type

A/An Cisco ISE publish settings struct struct.

Create

The default value is empty.

Search

The field is not available for search.

resolved_address

resolved_address

The resolved IPv4 Address or IPv6 Address of the Cisco ISE endpoint.

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

The resolved_address is part of the base object.

The resolved_address cannot be updated.

resolved_address cannot be written.

resolved_secondary_address

resolved_secondary_address

The resolved IPv4 Address or IPv6 Address of the Cisco ISE endpoint.

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

The resolved_secondary_address cannot be updated.

resolved_secondary_address cannot be written.

secondary_address

secondary_address

The Cisco ISE endpoint secondary IPv4 Address or IPv6 Address or Fully-Qualified Domain Name (FQDN)

Type

String.

Create

The default value is empty.

Search

The field is available for search via

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

subscribe_settings

subscribe_settings

The Cisco ISE subscribe settings.

Type

A/An Cisco ISE subscribe settings struct struct.

Create

The field is required on creation.

Search

The field is not available for search.

subscribing_member

subscribing_member

The name of the Grid Member object that is serving Cisco ISE endpoint.

Type

String.

Create

The field is required on creation.

Search

The field is available for search via

  • ‘=’ (exact equality)

type

type

The Cisco ISE endpoint type.

Type

String.

Valid values are:
  • TYPE_CISCO

Create

The default value is undefined.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The type is part of the base object.

version

version

The Cisco ISE endpoint version.

Type

String.

Values with leading or trailing white space are not valid for this field.

Valid values are:
  • VERSION_1_3
  • VERSION_1_4
  • VERSION_2_0

Create

The field is required on creation.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The version is part of the base object.

Function Calls

test_connection

Use this function to test a connection to the Cisco endpoint.

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

Input fields

None

Output fields

result ( String. Valid values are: “CANNOT_RESOLVE_FQDN”, “FAIL”, “OK”, “WARN” ) The result of connection testing to the syslog server.

Fields List

Field Type Req R/O Base Search
address String Y N Y : = ~
bulk_download_certificate_subject String N Y N N/A
bulk_download_certificate_token String Y N N N/A
bulk_download_certificate_valid_from Timestamp N Y N N/A
bulk_download_certificate_valid_to Timestamp N Y 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 : = ~
connection_status String N Y N N/A
connection_timeout Unsigned int N N N N/A
disable Bool N N Y N/A
extattrs Extattr N N N ext
network_view String N N N =
publish_settings struct N N N N/A
resolved_address String N Y Y = ~
resolved_secondary_address String N Y N = ~
secondary_address String N N N : = ~
subscribe_settings struct Y N N N/A
subscribing_member String Y N N =
type String N N Y =
version String Y N Y =