You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > AllOutOfService

AllOutOfService

Type

SwitchKit API message

Purpose

Use the SK_AllOutOfService message to automatically take all referenced entities out-of-service on any configured node prior to sending another configuration.

Description

SwitchManager takes all entities found on any configured node out-of-service after receiving this message. Sending this message saves you from having to explicitly add ServiceStateConfig messages for each entity.

Taking entities out-of-service prior to configuration is important to prevent system purges caused by configuring a channel that is in-service.

Important! Use of AllOutOfService is not recommended for dynamic configurations.

Sent by

SwitchManager

Configuration

AllOutOfService (

Node = integer,

ConnectionID = integer);