Search Results execute_icsm_cmd

Overview

IEO_ICSM_CMD_PUB is a public PL/SQL package owned by the APPS schema within the Oracle E-Business Suite Integrated Communication Services Manager (ICSM) module. Its central purpose is to provide a programmatic control interface for the servers and nodes registered in the ICSM topology. The package exposes utilities that allow EBS application code to interrogate node and server availability, dispatch generic operating system commands to managed servers, validate IP addresses, and manage the lifecycle of server processes (start, stop, ping). In effect, it functions as an infrastructure management API rather than a business-transaction API, and it is intended for use by administrative concurrent programs, configuration utilities, and system health checks that need to reach out to the underlying server tier.

The package declaration uses AUTHID CURRENT_USER, meaning it executes with the privileges of the invoking user rather than the definer. Comments inside the source reference a server status mask constant (G_SERVER_MASK := 5000000) and status literals such as ICSM_DOWN and SERVER_DOWN, indicating that server states are encoded numerically and that the package interprets these encodings on behalf of callers.

Key Procedures and Functions

• GET_NODE_STATUS – Returns a numeric status indicator describing whether a given ICSM node is reachable or up.
• GET_SERVER_STATUS – Returns a numeric status indicator for a specific registered server.
• EXECUTE_SERVER_CMD – Executes a generic operating system command string against a designated server identified by server ID. This is the procedure that the search term "execute_server_cmd" refers to. It follows the standard EBS API signature convention, with API version, message-list initialisation, and commit control parameters, and it returns an x_result flag (Y/N) plus the standard return status, message count, and message data outputs.
• EXECUTE_ICSM_CMD – Analogous to the preceding procedure but targets a command directed at an ICSM node rather than an application server.
• TEST_IP – Validates an IP address against a given node and reports validity through the x_result output.
• START_SERVER – Initiates a managed server process.
• STOP_SERVER – Terminates an individual managed server process.
• PING_SERVER – Issues a reachability test to a server.
• SHUTDOWN_ICSM – Shuts down the ICSM component itself.
• STOP_ALL_SERVER – Halts all registered servers, typically invoked as part of an outage or maintenance sequence.
• GET_LOG_FILES – Retrieves the list of log files associated with managed servers or nodes.
• DELETE_FILE – Removes a specified file from a managed server.

Tables Accessed

The package references two tables through APPS synonyms. IEO_NODES stores the definition of ICSM nodes, including node identifiers used by GET_NODE_STATUS, EXECUTE_ICSM_CMD, and TEST_IP. IEO_SVR_RT_INFO holds server runtime information, supplying the server identity and status data consumed by GET_SERVER_STATUS, EXECUTE_SERVER_CMD, START_SERVER, STOP_SERVER, PING_SERVER, and STOP_ALL_SERVER. Log-file and status queries also draw on this runtime information to resolve which servers exist before any command is dispatched.

Usage Notes

Because the package is a PUB-classified API, it is intended for direct invocation from other EBS components. It is referenced by two other packages within the product, which layer business-specific logic on top of the low-level command execution primitives. Typical callers include administrative concurrent programs and forms-based administration screens that start and stop servers or retrieve diagnostic logs. Custom code should invoke these procedures rather than connecting to the server tier directly, and callers should respect the standard FND_API error-handling pattern, always checking x_return_status and processing the message stack whenever x_msg_count is greater than zero. Commit semantics follow the p_commit flag, allowing the caller to retain transactional control. The package is present and documented in both EBS 12.1.1 and 12.2.2.