engineInfo

Namespace: (default namespace)
XML Schema: ns0.xsd

Contains information about an engine in a cluster.

XML

Elements

name (type) min/max
occurs
description
authenticated (boolean) 1/1 Returns whether the user is authenticated.
id (string) 0/1 Returns the engine id in the cluster.
port (int) 1/1 Returns the port for this engine.
username (string) 0/1 Returns the user logged in.
password (string) 0/1 Returns the password of the user logged in.
host (string) 0/1 Returns the host name where the engine is running.
name (string) 0/1 Returns the name of the represented engine.
securityEnabled (boolean) 1/1 Indicates whether this engine has security enabled.
running (boolean) 1/1 Returns whether this engine is running.
disposed (boolean) 1/1 Returns whether this engine is disposed.
totalPhysicalMemory (long) 1/1 Returns the total amount of virtual memory on the system running the engine, in kilobytes.
freePhysicalMemory (long) 1/1 Returns the amount of physical memory on the system running the engine, in kilobytes.
totalVirtualMemory (long) 1/1 Returns the total amount of virtual memory for the system running the engine, in kilobytes.
freeVirtualMemory (long) 1/1 Returns the amount of free virtual memory on the system running the engine, in kilobytes.
cpuUsage (float) 1/1 Returns the percentage of CPU usage for the system running the Flux engine. CPU usage is updated using the system resource command defined in the engine configuration.
cpuUsageFormatted (string) 0/1 Returns the formatted percentage of CPU usage for the system running the Flux engine. CPU usage is updated using the system resource command defined in the engine configuration.
totalPhysicalMemoryFormatted (string) 0/1 Returns the formatted total amount of virtual memory on the system running the engine, in kilobytes.
usedPhysicalMemoryFormatted (string) 0/1 Returns the formatted used amount of physical memory for the system running the engine.
totalVirtualMemoryFormatted (string) 0/1 Returns the formatted total amount of virtual memory for the system running the engine, in kilobytes.
usedVirtualMemoryFormatted (string) 0/1 Returns the formatted used amount of virtual memory for the system running the engine.
memoryLoadFormatted (string) 0/1 Returns the formatted physical memory load for the system running the engine.
memoryPercentage (int) 1/1 Returns the physical memory percentage for the system running the engine.
serverUrl (string) 0/1 Returns the server URL for this engine.
resourceMonitorConfigured (boolean) 1/1 Returns whether the resource monitor is configured in this engine.
status (string) 0/1 Returns the status of this engine. Status may be one of DISPOSED, RUNNING, STOPPED.
physicalMemoryPercent (int) 1/1 Returns the physical memory percentage for the system running the engine.
virtualMemoryPercent (int) 1/1 Returns the virtual memory percentage for the system running the engine.
hostAbbreviated (string) 0/1
preferenceLevel (int) 1/1
ssl (boolean) 1/1

JSON

property type description
authenticated authenticated (boolean) Returns whether the user is authenticated.
id id (string) Returns the engine id in the cluster.
port port (int) Returns the port for this engine.
username username (string) Returns the user logged in.
password password (string) Returns the password of the user logged in.
host host (string) Returns the host name where the engine is running.
name name (string) Returns the name of the represented engine.
securityEnabled securityEnabled (boolean) Indicates whether this engine has security enabled.
running running (boolean) Returns whether this engine is running.
disposed disposed (boolean) Returns whether this engine is disposed.
totalPhysicalMemory totalPhysicalMemory (long) Returns the total amount of virtual memory on the system running the engine, in kilobytes.
freePhysicalMemory freePhysicalMemory (long) Returns the amount of physical memory on the system running the engine, in kilobytes.
totalVirtualMemory totalVirtualMemory (long) Returns the total amount of virtual memory for the system running the engine, in kilobytes.
freeVirtualMemory freeVirtualMemory (long) Returns the amount of free virtual memory on the system running the engine, in kilobytes.
cpuUsage cpuUsage (float) Returns the percentage of CPU usage for the system running the Flux engine. CPU usage is updated using the system resource command defined in the engine configuration.
cpuUsageFormatted cpuUsageFormatted (string) Returns the formatted percentage of CPU usage for the system running the Flux engine. CPU usage is updated using the system resource command defined in the engine configuration.
totalPhysicalMemoryFormatted totalPhysicalMemoryFormatted (string) Returns the formatted total amount of virtual memory on the system running the engine, in kilobytes.
usedPhysicalMemoryFormatted usedPhysicalMemoryFormatted (string) Returns the formatted used amount of physical memory for the system running the engine.
totalVirtualMemoryFormatted totalVirtualMemoryFormatted (string) Returns the formatted total amount of virtual memory for the system running the engine, in kilobytes.
usedVirtualMemoryFormatted usedVirtualMemoryFormatted (string) Returns the formatted used amount of virtual memory for the system running the engine.
memoryLoadFormatted memoryLoadFormatted (string) Returns the formatted physical memory load for the system running the engine.
memoryPercentage memoryPercentage (int) Returns the physical memory percentage for the system running the engine.
serverUrl serverUrl (string) Returns the server URL for this engine.
resourceMonitorConfigured resourceMonitorConfigured (boolean) Returns whether the resource monitor is configured in this engine.
status status (string) Returns the status of this engine. Status may be one of DISPOSED, RUNNING, STOPPED.
physicalMemoryPercent physicalMemoryPercent (int) Returns the physical memory percentage for the system running the engine.
virtualMemoryPercent virtualMemoryPercent (int) Returns the virtual memory percentage for the system running the engine.
hostAbbreviated hostAbbreviated (string)
preferenceLevel preferenceLevel (int)
ssl ssl (boolean)