# System Information

> Symcon documentation · English · generated on 2026-09-26  
> Index: https://www.symcon.de/en/llms.txt

Source: https://www.symcon.de/en/service/documentation/module-reference/core-instances/system-information/

With the system features, you can read out information over your system and the existing hardware to visualize it or otherwise use it in scripts.

## Sys_GetBattery

Source: https://www.symcon.de/en/service/documentation/module-reference/core-instances/system-information/sys-getbattery/

`array Sys_GetBattery()`

displays information about the battery

**Returns** (array): Array with information about the battery

Gives information about the presence of a battery, whether it is in use and what percentage of the battery charge is left. The remaining time and maximum battery life are indicated in seconds.

**Example**

```php
print_r(Sys_GetBattery());
/*
// Sample output on a desktop PC without battery
// HasBattery is available with IP-Symcon 7.0+
Array
(
[HasBattery] =>
[OnBattery] =>
[IsCharging] =>
[BatteryLevel] => -1
[BatteryRemainingTime] => -1
[BatteryMaxTime] => -1
)
*/
```

## Sys_GetCPUInfo

Source: https://www.symcon.de/en/service/documentation/module-reference/core-instances/system-information/sys-getcpuinfo/

`array Sys_GetCPUInfo()`

shows the CPU usage

**Returns** (array): Array with information about CPU utilization

Provides for each CPU the current load (CPU_ *) and the average load of the last 60 seconds for all CPU cores (CPU_AVG). The average load is calculated by taking a measurement of each second of the value of the current load and is stored afterwards.The average load is calculated by adding the last 60 measured values and then divided by 60.

> **Note:** The average load is not the average load of the current load, but the average load of the last 60 seconds.

**Example**

```php
print_r(Sys_GetCPUInfo());

/*
Array
(
    [CPU_0] => 3
    [CPU_AVG] => 3
)
*/
```

## Sys_GetHardDiskInfo

Source: https://www.symcon.de/en/service/documentation/module-reference/core-instances/system-information/sys-getharddiskinfo/

`array Sys_GetHardDiskInfo()`

shows the hard disk space/usage

**Returns** (array): Array of information about all the hard drives

Provides information on the existing disks in the system, including the size and the already used memory.

**Example**

```php
print_r(Sys_GetHarddiskInfo());

/*
Array
(
    [HDD0] => Array
    (
        [LETTER] => c:\
        [LABEL] =>
        [TOTAL] => 53684989952
        [FREE] => 23275171840
    )

    [NUMDRIVES] => 1
)
*/
```

## Sys_GetMemoryInfo

Source: https://www.symcon.de/en/service/documentation/module-reference/core-instances/system-information/sys-getmemoryinfo/

`array Sys_GetMemoryInfo()`

shows the memory usage

**Returns** (array): Array of information on the overall memory usage and virtual memory usage

Provides information about the memory usage of the operating system.

**Example**

```php
print_r(Sys_GetMemoryInfo());

/*
Array
(
    [TOTALPHYSICAL] => 1072467968
    [AVAILPHYSICAL] => 526647296
    [TOTALPAGEFILE] => 2420019200
    [AVAILPAGEFILE] => 1386422272
    [TOTALVIRTUAL] => 2147352576
    [AVAILVIRTUAL] => 1906978816
)
*/
```

## Sys_GetNetworkInfo

Source: https://www.symcon.de/en/service/documentation/module-reference/core-instances/system-information/sys-getnetworkinfo/

`array Sys_GetNetworkInfo()`

shows information about the network adapters

**Returns** (array): Array with information about all network adapters

Provides information about all network adapters.

**Example**

```php
print_r(Sys_GetNetworkInfo());
/*
// Example output

Array
(
[0] =>	Array
		(
		[InterfaceIndex] => 10
		[IP] => 192.168.1.2
		[MAC] => 00:A0:03:AD:14:BD
		[Description] => Siemens I BT USB Remote NDIS Network Device
		[Speed] => 9728000
		[InTotal] => 40236
		[OutTotal] => 247248
		)

[1] =>	Array
		(
		[InterfaceIndex] => 13
		[IP] => 172.12.1.200
		[MAC] => 00:A0:03:AD:14:BD
		[Description] => Qualcomm Atheros AR8151 PCI-E Gigabit Ethernet Controller (NDIS 6.30)
		[Speed] => 1000000000
		[InTotal] => 169987950
		[OutTotal] => 86029648
		)
)
*/
```

## Sys_GetProcessInfo

Source: https://www.symcon.de/en/service/documentation/module-reference/core-instances/system-information/sys-getprocessinfo/

`array Sys_GetProcessInfo()`

lists all processes

**Returns** (array): Array of information, such as e.g. Memory usage and number of threads

Provides information about the process of IP Symcon.

**Example**

```php
print_r(Sys_GetProcessInfo());
/*
Array
(
    [IPS_HANDLECOUNT] => 635
    [IPS_NUMTHREADS] => 53
    [IPS_VIRTUALSIZE] => 240373760
    [IPS_WORKINGSETSIZE] => 32706560
    [IPS_PAGEFILE] => 52719616
    [PROCESSCOUNT] => 53
)
*/
```

## Sys_GetSpooler

Source: https://www.symcon.de/en/service/documentation/module-reference/core-instances/system-information/sys-getspooler/

`array Sys_GetSpooler()`

displays information about the printer queues

**Returns** (array): Array of information about all the printing queues and being printed documents

Provides information about all print queues

> **Warning:** This function only works in Windows

**Example**

```php
print_r(Sys_GetSpooler());
```

## Sys_GetURLContent

Source: https://www.symcon.de/en/service/documentation/module-reference/core-instances/system-information/sys-geturlcontent/

`string Sys_GetURLContent(string $URL)`

reads the content from an URL as String

**Parameters**

- `$URL` (string): Complete URL

**Returns** (string): If the command was executed successfully, it returns the result of the website contents (including binary code), otherwise __FALSE__.

Complete URL

**Example**

```php
echo Sys_GetURLContent("http://www.google.de");
```

## Sys_GetURLContentEx

Source: https://www.symcon.de/en/service/documentation/module-reference/core-instances/system-information/sys-geturlcontentex/

`string Sys_GetURLContentEx(string $URL, array $Parameter)`

Reads the contents of the __URL__ and returns it as a return value. Here, some __Parameter__ for timeouts, authentication and proxy are made.
-

**Parameters**

- `$URL` (string): Complete URL
- `$Parameter` (array)

  Array with index => value pairs

  | Index      | Type    | Description                                                                                 |
  | ---------- | ------- | ------------------------------------------------------------------------------------------- |
  | Timeout    | Integer | __Default = 10000__. Timeout in milliseconds                                                |
  | AuthUser   | String  | __Default = ""__. Username for basic authentication                                         |
  | AuthPass   | String  | __Default = ""__. Password for basic authentication                                         |
  | VerifyPeer | Boolean | __Default = true__. Verify that hosts SSL certificate is correct                            |
  | VerifyHost | Boolean | __Default = true__. Verify that host URL from the SSL certificate matches the property Host |

**Returns** (string): If the command was executed successfully, it returns the result of the website contents (including binary code), otherwise __FALSE__.

Array with index => value pairs

| Index      | Type    | Description                                                                                 |
| ---------- | ------- | ------------------------------------------------------------------------------------------- |
| Timeout    | Integer | __Default = 10000__. Timeout in milliseconds                                                |
| AuthUser   | String  | __Default = ""__. Username for basic authentication                                         |
| AuthPass   | String  | __Default = ""__. Password for basic authentication                                         |
| VerifyPeer | Boolean | __Default = true__. Verify that hosts SSL certificate is correct                            |
| VerifyHost | Boolean | __Default = true__. Verify that host URL from the SSL certificate matches the property Host |

**Example**

```php
echo Sys_GetURLContentEx("http://www.google.de", Array("AuthUser"=> "test", "AuthPass"=> "test"));
```

## Sys_Ping

Source: https://www.symcon.de/en/service/documentation/module-reference/core-instances/system-information/sys-ping/

`bool Sys_Ping(string $Host, int $Timeout)`

sends a ping to a network device

**Parameters**

- `$Host` (string): Hostname or IP address
- `$Timeout` (int): Time in milliseconds

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

Time in milliseconds

**Example**

```php
Sys_Ping("meinrechner", 1000); //Wait max. 1 second
```