Powered by

#RPC connect-node

This RPC establishes connection to all notification streams belonging to an installed nodes. The connection is created outside a transaction, so that the connection stays up even without active transactions.

The connect-node RPC also supports connection to a specific stream node by specifying the stream node name in the RPC. Examples are shown below.

#RPC parameters

  • node-id (mandatory) - ID of a node.
  • stream-name (optional) - Name of a stream.
  • max-connection-attempts (optional) - Maximum number of connection attempts. The default value is 1.
  • between-attempts-timeout (optional) - Timeout between connection attempts in seconds. The default value is 60 seconds.

#UniConfig Shell

The connect-node RPC is also included in UniConfig shell. As it takes node-id as input, the shell only suggests nodes that are relevant to this RPC (nodes that are installed in UniConfig topology).

#RPC examples

For all examples, assume that the install-node RPC request included the following parameters:

{
    "input": {
        "nodes": [
            {
                "node-id": "R1",
                "netconf": {
                    "...":  "...",
                    "stream": [
                        {
                            "stream-name": "NETCONF"
                        }
                    ]
                }
            }
        ]
    }
}

#Successful example - Request to establish connection to all notification streams.

RPC Request
curl --location --request POST 'http://localhost:8181/rests/operations/connection-manager:connect-node' \
--header 'Authorization: Basic YWRtaW46YWRtaW4=' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Cookie: Cookie_1=value' \
--data-raw '{
    "input": {
        "node-id": "R1",
        "max-connection-attempts": 1,
        "between-attempts-timeout": 1
    }
}'
RPC Response, Status: 200

#Failed example - All notification streams are already connected

RPC Response, Status: 409
{
    "errors": {
        "error": [
            {
                "error-tag": "in-use",
                "error-type": "application",
                "error-message": "All connections for node R1 are already established."
            }
        ]
    }
}

#Failed example - No available subscriptions to notification streams

RPC Response, Status: 404
{
    "errors": {
        "error": [
            {
                "error-tag": "in-use",
                "error-type": "application",
                "error-message": "There are no available connections for node: R1"
            }
        ]
    }
}

#Successful example - Request for a specific stream node

RPC Request
curl --location --request POST 'http://localhost:8181/rests/operations/connection-manager:connect-node' \
--header 'Authorization: Basic YWRtaW46YWRtaW4=' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Cookie: Cookie_1=value' \
--data-raw '{
    "input": {
        "node-id": "R1",
        "stream-name": "NETCONF",
        "max-connection-attempts": 1,
        "between-attempts-timeout": 1
    }
}'
RPC Response, Status: 200

#Failed example - Node is already connected

RPC Response, Status: 409
{
    "errors": {
        "error": [
            {
                "error-tag": "in-use",
                "error-type": "application",
                "error-message": "Notification stream NETCONF for node R1 is already connected."
            }
        ]
    }
}

#Failed example - Node is in the process of connecting

RPC Response, Status: 409
{
    "errors": {
        "error": [
            {
                "error-tag": "in-use",
                "error-type": "application",
                "error-message": "Some connections are in the process of connecting. Try again later."
            }
        ]
    }
}
RPC Response, Status: 409
{
    "errors": {
        "error": [
            {
                "error-tag": "in-use",
                "error-type": "application",
                "error-message": "Some connections are in the process of connecting or failed to connect. Try again later."
            }
        ]
    }
}