allendpoints : All Endpoints object.

The object provides information about all thrid-party servers configured on the Grid.

Object Reference

References to allendpoints are object references.

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

  • name of the endpoint for DXL and RESTAPI endpoints or an address for the Cisco ISE endpoint

Example: allendpoints/ZG5zLm5ldHdvcmtfdmlldyQxMTk:10.0.0.10

Restrictions

The object does not support the following operations:

  • Create (insert)
  • Delete
  • Modify (update)
  • Permissions
  • 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.

address

address

The Grid endpoint IPv4 Address or IPv6 Address or Fully-Qualified Domain Name (FQDN).

Type

String.

Search

The field is available for search via

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

Notes

The address cannot be updated.

address cannot be written.

comment

comment

The Grid endpoint descriptive comment.

Type

String.

Search

The field is available for search via

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

Notes

The comment cannot be updated.

comment cannot be written.

disable

disable

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

Type

Bool.

Search

The field is not available for search.

Notes

The disable cannot be updated.

disable cannot be written.

subscribing_member

subscribing_member

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

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The subscribing_member cannot be updated.

subscribing_member cannot be written.

type

type

The Grid endpoint type.

Type

String.

Valid values are:
  • TYPE_CISCO
  • TYPE_DXL
  • TYPE_RESTAPI

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The type cannot be updated.

type cannot be written.

version

version

The Grid endpoint version.

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The version cannot be updated.

version cannot be written.

Fields List

Field Type Req R/O Base Search
address String N Y N : = ~
comment String N Y N : = ~
disable Bool N Y N N/A
subscribing_member String N Y N =
type String N Y N =
version String N Y N =