setonline and setoffline

Overview

You can use the setoffline command when you plan not to run tasks on specific workstations. You can use the setonline command to bring back the same workstation online.

You can also use the setoffline command to set an event source or an endpoint offline. An offline event source does not receive any events, and an offline endpoint prevents the submission of tasks referencing it. You can use the setonline command to restore an event source or endpoint back to service.

Important:

The required security access depends on the action you are performing and the item you are modifying:

To set a workstation, event source, or endpoint online, you must have LINK access to that specific item.
To set a workstation, event source, or endpoint offline, you must have UNLINK access to that specific item.

Syntax and command line options

Workstation

You can enter the command as follows. To make a workstation available to run the tasks, use the following command:

ocli plan setonline| seton workstation

Run the following command to set a workstation unavailable:

ocli plan setoffline| setoff workstation

You must also specify the workstation name. After the command runs, the tasks on the offline workstation are displayed as READY and run after the workstation is available.

Event source

You can enter the command as follows. To make an event source able to receive events, use the following command:

ocli plan setonline| seton eso eventsource

Run the following command to set a workstation unavailable:

ocli plan setoffline| setoff eso eventsource

You must also specify the event source name. After the commands run, the event source status and actual status are displayed.

Endpoint

You can use the setoffline command to manually take an endpoint out of service:

ocli plan setoffline endpoint ENDPOINT_NAME

When an endpoint is set to Offline, the Orchestrator prevents the submission of any tasks that reference that endpoint. Tasks remain in the READY: waiting for endpoint state.

You can use the setonline command to restore the endpoint to service:

ocli plan setonline endpoint ENDPOINT_NAME

If monitoring is enabled, the system resumes connectivity checks.

Examples

Workstation

Run the following command to make the WS_AGT_0 workstation available:
```
ocli plan setonline /WS_AGT_0
```
Run the following command to make the WS_AGT_0 workstation unavailable:
```
ocli plan setoffline /WS_AGT_0
```

Event source

Run the following command to make the MY_SOURCE event source able to receive events:
```
ocli plan setonline eso /MY_SOURCE
```
Run the following command to make the MY_SOURCE workstation unable to receive events:
```
ocli plan setoffline eso /MY_SOURCE
```