1 PACKAGE IEO_ICSM_CMD_PUB AUTHID CURRENT_USER AS
2 /* $Header: ieocmds.pls 115.9 2003/09/03 20:02:56 edwang noship $ */
3
4 G_PKG_NAME CONSTANT VARCHAR2(30) := 'IEO_ICSM_CMD_PUB';
5 G_ICSM_DOWN CONSTANT VARCHAR2(30) := 'ICSM_DOWN';
6 G_SERVER_DOWN CONSTANT VARCHAR2(30) := 'SERVER_DOWN';
7 G_SERVER_MASK CONSTANT NUMBER := 5000000;
8
9 -- IS_NODE_UP
10 -- Test if Node is up
11 -- @param in p_node_id the node id
12 -- @param out x_result Y if node is up , N if not
13 FUNCTION GET_NODE_STATUS
14 (
15 p_node_id IN NUMBER
16 )
17 RETURN NUMBER ;
18
19 FUNCTION GET_SERVER_STATUS
20 (
21 p_server_id IN NUMBER
22 )
23 RETURN NUMBER ;
24
25
26 -- EXECUTE_SERVER_CMD
27 -- execute a generic command
28 -- @param in p_cmd the cmd string
29 -- @param in p_server_id the server id
30 -- @param out x_result Y = valid , N = not valid
31 PROCEDURE EXECUTE_SERVER_CMD
32 (
33 p_api_version IN NUMBER,
34 p_init_msg_list IN VARCHAR2 Default FND_API.G_FALSE,
35 p_commit IN VARCHAR2 Default FND_API.G_FALSE,
36
37 p_cmd IN VARCHAR2,
38 p_server_id IN NUMBER,
39 x_result OUT NOCOPY VARCHAR2,
40
41 x_return_status OUT NOCOPY VARCHAR2,
42 x_msg_count OUT NOCOPY NUMBER,
43 x_msg_data OUT NOCOPY VARCHAR2
44 );
45
46
47 -- EXECUTE_ICSM_CMD
48 -- execute a generic ICSM command
49 -- @param in p_cmd the cmd string
50 -- @param in p_node_id the ICSM node id
51 -- @param out x_result Y = valid , N = not valid
52 PROCEDURE EXECUTE_ICSM_CMD
53 (
54 p_api_version IN NUMBER,
55 p_init_msg_list IN VARCHAR2 Default FND_API.G_FALSE,
56 p_commit IN VARCHAR2 Default FND_API.G_FALSE,
57
58 p_cmd IN VARCHAR2,
59 p_node_id IN NUMBER,
60 x_result OUT NOCOPY VARCHAR2,
61
62 x_return_status OUT NOCOPY VARCHAR2,
63 x_msg_count OUT NOCOPY NUMBER,
64 x_msg_data OUT NOCOPY VARCHAR2
65 );
66
67 -- TEST_IP
68 -- Test the validity of an IP address on a node
69 -- @param in p_ip_addr the IP address
70 -- @param in p_node_id the node id
71 -- @param out x_result Y = valid , N = not valid
72 PROCEDURE TEST_IP
73 (
74 p_api_version IN NUMBER,
75 p_init_msg_list IN VARCHAR2 Default FND_API.G_FALSE,
76 p_commit IN VARCHAR2 Default FND_API.G_FALSE,
77
78 p_ip_addr IN VARCHAR2,
79 p_node_id IN NUMBER,
80 x_result OUT NOCOPY VARCHAR2,
81
82 x_return_status OUT NOCOPY VARCHAR2,
83 x_msg_count OUT NOCOPY NUMBER,
84 x_msg_data OUT NOCOPY VARCHAR2
85 );
86
87 -- START_SERVER
88 -- Start a server
89 -- @param in p_server_name the server name to start
90 -- @param in p_node_id the node id
91 PROCEDURE START_SERVER
92 (
93 p_api_version IN NUMBER,
94 p_init_msg_list IN VARCHAR2 Default FND_API.G_FALSE,
95 p_commit IN VARCHAR2 Default FND_API.G_FALSE,
96
97 p_server_name IN VARCHAR2,
98 p_node_id IN NUMBER,
99
100 x_return_status OUT NOCOPY VARCHAR2,
101 x_msg_count OUT NOCOPY NUMBER,
102 x_msg_data OUT NOCOPY VARCHAR2,
103 x_xml_data OUT NOCOPY VARCHAR2
104 );
105
106 -- STOP_SERVER
107 -- Stop a server
108 -- @param in p_server_name the server name to stop
109 -- @param in p_node_id the node id
110 PROCEDURE STOP_SERVER
111 (
112 p_api_version IN NUMBER,
113 p_init_msg_list IN VARCHAR2 Default FND_API.G_FALSE,
114 p_commit IN VARCHAR2 Default FND_API.G_FALSE,
115
116 p_server_name IN VARCHAR2,
117 p_node_id IN NUMBER,
118
119 x_return_status OUT NOCOPY VARCHAR2,
120 x_msg_count OUT NOCOPY NUMBER,
121 x_msg_data OUT NOCOPY VARCHAR2
122 );
123
124 -- PING_SERVER
125 -- Start a server
126 -- @param in p_server_name the server name to start
127 -- @param in p_node_id the node id
128 -- @param out x_status the status
129 PROCEDURE PING_SERVER
130 (
131 p_api_version IN NUMBER,
132 p_init_msg_list IN VARCHAR2 Default FND_API.G_FALSE,
133 p_commit IN VARCHAR2 Default FND_API.G_FALSE,
134
135 p_server_name IN VARCHAR2,
136 p_node_id IN NUMBER,
137 x_status OUT NOCOPY VARCHAR2,
138
139 x_return_status OUT NOCOPY VARCHAR2,
140 x_msg_count OUT NOCOPY NUMBER,
141 x_msg_data OUT NOCOPY VARCHAR2
142 );
143
144
145 -- SHUTDOWN_ICSM
146 -- Shutdown ICSM
147 -- @param in p_node_id the node id
148 PROCEDURE SHUTDOWN_ICSM
149 (
150 p_api_version IN NUMBER,
151 p_init_msg_list IN VARCHAR2 Default FND_API.G_FALSE,
152 p_commit IN VARCHAR2 Default FND_API.G_FALSE,
153
154 p_node_id IN NUMBER,
155
156 x_return_status OUT NOCOPY VARCHAR2,
157 x_msg_count OUT NOCOPY NUMBER,
158 x_msg_data OUT NOCOPY VARCHAR2
159 );
160
161 -- STOP_ALL_SERVER
162 -- Stop all serevr
163 -- @param in p_node_id the node id
164 PROCEDURE STOP_ALL_SERVER
165 (
166 p_api_version IN NUMBER,
167 p_init_msg_list IN VARCHAR2 Default FND_API.G_FALSE,
168 p_commit IN VARCHAR2 Default FND_API.G_FALSE,
169
170 p_node_id IN NUMBER,
171
172 x_return_status OUT NOCOPY VARCHAR2,
173 x_msg_count OUT NOCOPY NUMBER,
174 x_msg_data OUT NOCOPY VARCHAR2
175 );
176
177 -- GET_LOG_FILES
178 -- Get log files in XML format
179 -- @param in p_node_id the node id
180 -- @param in p_server_name the server name
181 -- @param in p_fetch_count the max rows need to be returned
182 -- @param in p_page_count the page count
183 -- @param out x_xml_data the xml data
184 PROCEDURE GET_LOG_FILES
185 (
186 p_api_version IN NUMBER,
187 p_init_msg_list IN VARCHAR2 Default FND_API.G_FALSE,
188 p_commit IN VARCHAR2 Default FND_API.G_FALSE,
189
190 p_node_id IN NUMBER,
191 p_server_name IN VARCHAR2,
192 p_fetch_count IN NUMBER,
193 p_page_count IN NUMBER,
194 x_xml_data OUT NOCOPY VARCHAR2,
195
196 x_return_status OUT NOCOPY VARCHAR2,
197 x_msg_count OUT NOCOPY NUMBER,
198 x_msg_data OUT NOCOPY VARCHAR2
199 );
200
201 -- DELETE_FILE
202 -- Delete a file on ICSM server
203 -- @param in p_node_id the node id
204 -- @param in p_server_name the server name
205 -- @param in p_file_name the file name
206 PROCEDURE DELETE_FILE
207 (
208 p_api_version IN NUMBER,
209 p_init_msg_list IN VARCHAR2 Default FND_API.G_FALSE,
210 p_commit IN VARCHAR2 Default FND_API.G_FALSE,
211
212 p_node_id IN NUMBER,
213 p_server_name IN VARCHAR2,
214 p_file_name IN VARCHAR2,
215
216 x_return_status OUT NOCOPY VARCHAR2,
217 x_msg_count OUT NOCOPY NUMBER,
218 x_msg_data OUT NOCOPY VARCHAR2
219 );
220
221 END IEO_ICSM_CMD_PUB;