The pxgrid endpoint object represents the settings of a particular PXGRID endpoint.
References to pxgrid:endpoint are object references.
The name part of the pxgrid:endpoint object reference has the following components:
- The name of an endpoint.
Example: pxgrid:endpoint/b25lLmVuZHBvaW50JDMzOQ:wintermute
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): address, disable, name, outbound_member_type.
The following fields are required to create this object:
| Field | Notes |
|---|---|
| address | |
| client_certificate_token | |
| name | |
| outbound_member_type | |
| subscribe_settings |
The pxgrid 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
Notes
The address is part of the base object.
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.
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.
The pxgrid endpoint 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.
The pxgrid endpoint 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.
The Cisco ISE endpoint descriptive comment.
Type
String.
Create
The default value is empty.
Search
The field is available for search via
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.
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 pxgrid endpoint.
Type
String.
Create
The default value is WARNING.
Search
The field is available for search via
The name of the pxgrid 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 pxgrid network view name.
Type
String.
Create
The default value is undefined.
Search
The field is available for search via
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.
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.
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.
The Pxgrid template instance. You cannot change the parameters of the pxgrid 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
Use this function to test a connection to the pxgrid 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: “SUCCESS”, “FAILURE” ) The result of connection testing to the pxgrid endpoint.
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| address | String | Y | N | Y | : = ~ |
| 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 | : = ~ |
| disable | Bool | N | N | Y | N/A |
| extattrs | Extattr | N | N | N | ext |
| log_level | String | N | N | N | = |
| name | String | Y | N | Y | : = ~ |
| network_view | String | N | N | N | = |
| outbound_member_type | String | Y | N | Y | = |
| outbound_members | [String] | N | N | N | N/A |
| publish_settings | struct | N | N | N | N/A |
| subscribe_settings | struct | Y | 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 |
permission : Permissions object.
radius:authservice : The RADIUS authentication service object.
