MIDServer - Global
-
- UpdatedJan 30, 2025
- 15 minutes to read
- Yokohama
- API reference
The MIDServer script include provides methods to encapsulate the notion of a MID Server.
Use these methods in server scripts to manage a MID Server using Ajax.
MIDServer - getByName(String name)
Returns the specified MID server.
Name | Type | Description |
---|---|---|
name | String | The MID server name |
Type | Description |
---|---|
GlideRecord | The record of the requested MID server. |
Example
The following example shows how to access and display mid server details.
Output:
MIDServer - getDefault(DiscoverySchedule schedule)
Returns the MID server associated with the specified schedule (the MID server with the same name). If there is no associated MID server, gets the next MID server in the ecc_agent table.
Name | Type | Description |
---|---|---|
schedule | DiscoverySchedule | The discovery schedule |
Type | Description |
---|---|
GlideRecord | The MID server |
MIDServer - getForPing(DiscoverySchedule schedule, DiscoveryRange range)
Returns the MID Server with the specified schedule and range set.
Name | Type | Description |
---|---|---|
schedule | DiscoverySchedule | The discovery schedule |
range | DiscoveryRange | The discovery range set |
Type | Description |
---|---|
GlideRecord | The MID server |
MIDServer - hostname
The name of the MID server's host.
Name | Type | Description |
---|---|---|
hostname | String | The name of the MID server's host. |
Example
The following example shows how to execute and return all parameters of an available Mid server.
Output:
Example
MIDServer - hostOS
The operating system of the MID server's host.
Name | Type | Description |
---|---|---|
hostOS | String | The operating system of the MID server's host. |
Example
The following example shows how to execute and return all parameters of an available Mid server.
Output:
MIDServer - ip
The IP address of the MID server's host.
Name | Type | Description |
---|---|---|
ip | String | The IP address of the MID server's host. |
Example
The following example shows how to execute and return all parameters of an available Mid server.
Output:
MIDServer - name
Name of the MID server.
Name | Type | Description |
---|---|---|
name | String | Name of the MID server |
Example
The following example shows how to execute and return all parameters of an available Mid server.
Output:
MIDServer - network
The network containing the MID server's host.
Name | Type | Description |
---|---|---|
network | String | The network containing the MID server's host. For example, "10.10.10.0/24" or "10.10.10.0/255.255.255.0". |
Example
The following example shows how to execute and return all parameters of an available Mid server.
Output:
MIDServer - routerIP
The IP address of the MID server host's default router.
Name | Type | Description |
---|---|---|
routerIP | String | The IP address of the MID server host's default router. |
Example
The following example shows how to execute and return all parameters of an available Mid server.
Output:
MIDServer - status
The MID server's status ("Up" or "Down").
Name | Type | Description |
---|---|---|
status | String | The MID server's status ("Up" or "Down"). |
Example
The following example shows how to execute and return all parameters of an available Mid server.
Output:
MIDServer - sysID
The sys_id of the MID server record.
Name | Type | Description |
---|---|---|
sysID | String | The sys_id of the MID server record. |
Example
The following example shows how to execute and return all parameters of an available Mid server.
Output:
MIDServer - url
The URL the MID server uses to contact the instance.
Name | Type | Description |
---|---|---|
url | String | The URL the MID server uses to contact the instance. |
Example
The following example shows how to execute and return all parameters of an available Mid server.
Output:
MIDServer - version
Version of the MID server (WAR name).
Name | Type | Description |
---|---|---|
version | String | Version of the MID server (WAR name). |
Example
The following example shows how to execute and return all parameters of an available Mid server.
Output:
MIDServer - windowsDomain
Windows domain of the MID server's host (if it is a Windows machine).
Name | Type | Description |
---|---|---|
windowsDomain | String | The Windows domain of the MID server's host. |
Example
The following example shows how to execute and return all parameters of an available Mid server.
Output:
On this page
- MIDServer - getByName(String name)
- MIDServer - getDefault(DiscoverySchedule schedule)
- MIDServer - getForPing(DiscoverySchedule schedule, DiscoveryRange range)
- MIDServer - hostname
- MIDServer - hostOS
- MIDServer - ip
- MIDServer - name
- MIDServer - network
- MIDServer - routerIP
- MIDServer - status
- MIDServer - sysID
- MIDServer - url
- MIDServer - version
- MIDServer - windowsDomain