Description

The addTestIdentityServicesEngineConnectivity operation handles configuration related to TestIdentityServicesEngineConnectivity model. 
This API call is not allowed on the standby unit in an HA pair.

HTTP request

POST /api/fdm/v6/action/testidentityservicesengineconnectivity

Data Parameters

Parameter Required Type Description
ftdCertificateUUID True string The internal certificate that the system must provide to Identity Services Engine (ISE) when connecting to ISE or when performing bulk downloads
Field level constraints: cannot be null. (Note: Additional constraints might exist)
pxGridCertificateUUID True string The trusted CA certificate for the pxGrid framework. If your deployment includes a primary and a secondary pxGrid node, the CA certificates for both nodes must be signed by the same certificate authority
Field level constraints: cannot be null. (Note: Additional constraints might exist)
mntCertificateUUID True string The trusted CA certificate for the MNT server in the Identity Services Engine (ISE) deployment. If your deployment includes a primary and a secondary MNT node, the CA certificates for both nodes must be signed by the same certificate authority
Field level constraints: cannot be null. (Note: Additional constraints might exist)
subscribeToSessionDirectoryTopic True boolean Toggles subscription to SessionDirectory pxGrid topic, handling user sessions. If no value is given, the subscription will be enabled by default
Field level constraints: cannot be null. (Note: Additional constraints might exist)
subscribeToSxpTopic True boolean Toggles subscription to SXP pxGrid topic, handling SGT bindings. If no value is given, the subscription will be disabled by default
Field level constraints: cannot be null. (Note: Additional constraints might exist)
statusCode False string The ISE connection test error or success code returned by the ADI process
statusMessage False string The ISE connection test error or success message returned by the ADI process
iseLogMessage False string The detailed log message returned by the ADI process
primaryStatusCode False string The ISE connection test error or success code returned by the ADI process for the primary ISE server
primaryStatusMessage False string The ISE connection test error or success message returned by the ADI process for the primary ISE server
secondaryStatusCode False string The ISE connection test error or success code returned by the ADI process for the secondary ISE server
secondaryStatusMessage False string The ISE connection test error or success message returned by the ADI process for the secondary ISE server
secondaryIseServer False string The address of the optional secondary Identity Services Engine (ISE) server
primaryIseServer False string The address of the primary Identity Services Engine (ISE) server
type True string A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.

Example

curl -X POST \
    --header "Accept: application/json" \
    --header "Authorization: Bearer ${ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    -d '{
        "ftdCertificateUUID": "string",
        "id": "string",
        "iseLogMessage": "string",
        "mntCertificateUUID": "string",
        "primaryIseServer": "string",
        "primaryStatusCode": "string",
        "primaryStatusMessage": "string",
        "pxGridCertificateUUID": "string",
        "secondaryIseServer": "string",
        "secondaryStatusCode": "string",
        "secondaryStatusMessage": "string",
        "statusCode": "string",
        "statusMessage": "string",
        "subscribeToSessionDirectoryTopic": true,
        "subscribeToSxpTopic": true,
        "type": "TestIdentityServicesEngineConnectivity"
    }' \
    "https://${HOST}:${PORT}/api/fdm/v6/action/testidentityservicesengineconnectivity"
from bravado.requests_client import RequestsClient
from bravado.client import SwaggerClient


def get_client(host, token):
    http_client = RequestsClient()
    http_client.ssl_verify = False
    http_client.set_api_key(
        host,
        "Bearer {}".format(token),
        param_name="Authorization",
        param_in="header"
    )
    return SwaggerClient.from_url(
        "https://{}/apispec/ngfw.json".format(host),
        http_client=http_client,
        config={
            "validate_responses": False,
            "validate_swagger_spec": False
        }
    )


def add_test_identity_services_engine_connectivity(client, body):
    return client.TestIdentityServicesEngineConnectivity.addTestIdentityServicesEngineConnectivity(
        body=body
    ).response().result


if __name__ == "__main__":
    host = "ftd.example.com"
    token = "access_token"
    client = get_client(host, token)

    body = {'ftdCertificateUUID': 'string',
 'iseLogMessage': 'string',
 'mntCertificateUUID': 'string',
 'primaryIseServer': 'string',
 'primaryStatusCode': 'string',
 'primaryStatusMessage': 'string',
 'pxGridCertificateUUID': 'string',
 'secondaryIseServer': 'string',
 'secondaryStatusCode': 'string',
 'secondaryStatusMessage': 'string',
 'statusCode': 'string',
 'statusMessage': 'string',
 'subscribeToSessionDirectoryTopic': True,
 'subscribeToSxpTopic': True,
 'type': 'TestIdentityServicesEngineConnectivity'}

    add_test_identity_services_engine_connectivity(client, body)