session

addNodeStatus

Description

The addNodeStatus action lists details about machines that are currently being added to the server. This is particularly useful in a distributed environment to monitor the status of worker nodes joining the CAS cluster. It helps administrators verify that new nodes are being added successfully and to troubleshoot any issues that may arise during the process.

session.addNodeStatus <result=results> <status=rc>;
Data Preparation View data prep sheet
Prerequisites

This action does not require any specific data to be created beforehand. It is a server monitoring action.

Copied!
1/* No
2data creation is necessary to use this action. */

Examples

This example calls the addNodeStatus action to retrieve the current status of any nodes being added to the CAS server.

SAS® / CAS Code Code awaiting community validation
Copied!
1PROC CAS;
2 SESSION.addNodeStatus;
3RUN;
Result :
The action returns a result table that lists the machines being added and their current status. If no nodes are being added, the result might be empty or indicate that no add-node operations are in progress.

This example demonstrates how to call the addNodeStatus action and store the output in a CASL variable named 'nodeStatusResult'. This allows for further programmatic inspection of the results, for instance, to check if a specific node has successfully joined.

SAS® / CAS Code Code awaiting community validation
Copied!
1PROC CAS;
2 SESSION.addNodeStatus RESULT=nodeStatusResult;
3 PRINT nodeStatusResult;
4RUN;
Result :
The results, including a table with the status of nodes being added, are stored in the 'nodeStatusResult' variable and then printed to the log. The table contains columns such as 'Node', 'State', and potentially other details about the connection process.

FAQ

What is the purpose of the `addNodeStatus` action in SAS Viya?
Which action set does the `addNodeStatus` action belong to?
How do you use the `addNodeStatus` action in CASL?
What is the syntax for the `addNodeStatus` action in Python?
What is the syntax for the `addNodeStatus` action in R?
How can I execute the `addNodeStatus` action in Lua?

Associated Scenarios

Use Case
Standard Monitoring during a Planned Cluster Expansion

A CAS administrator is performing a routine, planned scale-out of the environment during a low-traffic maintenance window. They are adding two new worker nodes to an existing CA...

Use Case
Programmatic Tracking of a Large-Scale Node Addition

As part of a major infrastructure upgrade for a financial risk modeling platform, a systems architect is adding 10 new high-performance worker nodes to the CAS cluster simultane...

Use Case
Troubleshooting a Failed Node Addition and Verifying Idle State

A junior CAS administrator attempts to add a new worker node, but it fails to appear in the active node list. They suspect a network misconfiguration (e.g., a firewall blocking ...