Wiki source code of Server Configuration

Last modified by michaely on 2021/09/10 23:34
Show last authors
1 {{layout}}
2 {{layout-section ac:type="two_right_sidebar"}}
3 {{layout-cell}}
4 {{warning}}
5 This page is currently being written. Although the information below is probably accurate, it may not be complete or may have errors.
6 {{/warning}}
7
8 {{info}}
9 The information on this page applies to **iSymphony 3.1+**.
10 {{/info}}
11
12 = (% style="color: rgb(0,0,0);" %)Description(%%) =
13
14 The server REST resource allows access to top level configuration and information (e.g. Branding, Licensing, Administrators, ect.).
15
16
17 {{/layout-cell}}
18
19 {{layout-cell}}
20 {{panel title="On this page:"}}
21
22
23 {{toc maxLevel="2" indent="1"/}}
24 {{/panel}}
25 {{/layout-cell}}
26 {{/layout-section}}
27
28 {{layout-section ac:type="single"}}
29 {{layout-cell}}
30 = (% style="color: rgb(0,0,0);" %)Root Resource Path(%%) =
31
32 {{code}}
33 communication_manager/rest/config/server
34 {{/code}}
35
36 = JSON Representation =
37
38 {{code}}
39 {
40 "id": "afd57f4a-6c15-480b-b957-547085c49083",
41 "serverWebPort": 58080,
42 "serverWebSSLPort": 55050,
43 "serverEnabled": true,
44 "administrationInterfaceEnabled": true,
45 "clientInterfaceEnabled": true,
46 "communicationManagerEnabled": true,
47 "agentEnabled": false
48 }
49 {{/code}}
50
51 |=(((
52 Property
53 )))|=(((
54 Type
55 )))|=(((
56 Description
57 )))
58 |(((
59 {{{id}}}
60 )))|(((
61 String
62 )))|(((
63 The object id of the server configuration object. This property is irrelevant.
64 )))
65 |(% colspan="1" %)(% colspan="1" %)
66 (((
67 serverWebPort
68 )))|(% colspan="1" %)(% colspan="1" %)
69 (((
70 Integer
71 )))|(% colspan="1" %)(% colspan="1" %)
72 (((
73 The HTTP port for the web server.
74 )))
75 |(% colspan="1" %)(% colspan="1" %)
76 (((
77 serverWebSSLPort
78 )))|(% colspan="1" %)(% colspan="1" %)
79 (((
80 Integer
81 )))|(% colspan="1" %)(% colspan="1" %)
82 (((
83 The HTTPS port for the web server.
84 )))
85 |(% colspan="1" %)(% colspan="1" %)
86 (((
87 serverEnabled
88 )))|(% colspan="1" %)(% colspan="1" %)
89 (((
90 Boolean
91 )))|(% colspan="1" %)(% colspan="1" %)
92 (((
93 Flag specifying if the main server is enabled.
94 )))
95 |(% colspan="1" %)(% colspan="1" %)
96 (((
97 administrationInterfaceEnabled
98 )))|(% colspan="1" %)(% colspan="1" %)
99 (((
100 Boolean
101 )))|(% colspan="1" %)(% colspan="1" %)
102 (((
103 Flag specifying if the administration interface servlet is enabled.
104 )))
105 |(% colspan="1" %)(% colspan="1" %)
106 (((
107 clientInterfaceEnabled
108 )))|(% colspan="1" %)(% colspan="1" %)
109 (((
110 Boolean
111 )))|(% colspan="1" %)(% colspan="1" %)
112 (((
113 Flag specifying if the client interface servlet is enabled.
114 )))
115 |(% colspan="1" %)(% colspan="1" %)
116 (((
117 communicationManagerEnabled
118 )))|(% colspan="1" %)(% colspan="1" %)
119 (((
120 Boolean
121 )))|(% colspan="1" %)(% colspan="1" %)
122 (((
123 Flag specifying if the communication manager servlet is enabled.
124 )))
125 |(% colspan="1" %)(% colspan="1" %)
126 (((
127 agnetEnabled
128 )))|(% colspan="1" %)(% colspan="1" %)
129 (((
130 Booean
131 )))|(% colspan="1" %)(% colspan="1" %)
132 (((
133 Flag specifying if the agent is servlet enabled.
134 )))
135
136 = Resource Paths =
137
138 |=(% colspan="2" %)(% colspan="2" %)
139 (((
140 {{{communication_manager/rest/config/server}}}
141 )))
142 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
143 (((
144 **Description**
145 )))|(((
146 Accesses the top level configuration of the server.
147 )))
148 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
149 (((
150 **GET**
151 )))|(((
152 Gets the top level configuration of the server.
153 )))
154 |(% colspan="2" %)(% colspan="2" %)
155 (((
156
157 )))
158 |=(% colspan="2" %)(% colspan="2" %)
159 (((
160 {{{ }}}
161 )))
162 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
163 (((
164 **Description**
165 )))|(((
166 Accesses the administrators configured in the system.
167 )))
168 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
169 (((
170 **GET**
171 )))|(((
172 Gets the administrators configured in the system.
173 )))
174
175 = Sub/Child Resource Paths =
176
177 |=(% colspan="2" %)(% colspan="2" %)
178 (((
179 {{{communication_manager/rest/config/server/administrators}}}
180 )))
181 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
182 (((
183 **Description**
184 )))|(% colspan="1" %)(% colspan="1" %)
185 (((
186 Accesses the sub/child resources for (% style="color: rgb(51,51,51);" %)Administrators.
187
188 (% style="color: rgb(51,51,51);" %)See [[doc:Administrator Configuration]] for more information.
189 )))
190 |(% colspan="2" %)(% colspan="2" %)
191 (((
192
193 )))
194 |=(% colspan="2" %)(% colspan="2" %)
195 (((
196 {{{communication_manager/rest/config/server/coreServers}}}
197 )))
198 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
199 (((
200 **Description**
201 )))|(% colspan="1" %)(% colspan="1" %)
202 (((
203 Accesses the sub/child resources for Core Server Instances.
204
205 See [[doc:Core Server Instances]] for more information.
206 )))
207 |(% colspan="2" %)(% colspan="2" %)
208 (((
209
210 )))
211 |=(% class="highlight-grey" colspan="2" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="2" data-highlight-colour="grey" %)
212 (((
213 {{{communication_manager/rest/config/server/brand}}}
214 )))
215 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
216 (((
217 **Description**
218 )))|(((
219 Accesses the sub/child resources for branding, version, and build information.
220
221 See [[doc:Branding]] for more information.
222 )))
223
224 = Curl Examples =
225
226 === Get the top level server configuration ===
227
228 {{code language="bash"}}
229 curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" https://localhost:55050/communication_manager/rest/config/server
230 {{/code}}
231 {{/layout-cell}}
232 {{/layout-section}}
233 {{/layout}}

Search

Navigation

iSymphony