This class contains information on the ByteBlower System. More...

Methods
	Connection.Host.Get
	Returns the host (either registered name or IP address) used to connect to the ByteBlower server. More...

	Connection.IPAddress.Get
	Returns the IP address used to connect to the ByteBlower server. More...

	Connection.PortNumber.Get
	Returns the TCP port number of the connected ByteBlower server. More...

	Description.Get
	Returns a textual description of the object.

	License.Get
	Returns the License information for this ByteBlower server. More...

	MachineID.Get
	Returns a unique identifier for the machine where this ByteBlower server service runs on. More...

	Management.IPAddress.Get
	Returns all management IP addresses of the connected ByteBlower server. More...

	Parent.Get
	Returns the parent object.

	Series.Get
	Returns the server series of the connected ByteBlower server. More...

	ServiceID.Get
	Returns a unique service identifier for this ByteBlower service. More...

	Type.Get
	Retrieves the type of the ByteBlower service. More...

	Version.Get
	Returns the software version of the connected ByteBlower server. More...

Class overview

This class contains information on the ByteBlower System.

With this object you can get information concerning the Type / version / IP or hostname etc... information.

Example

 package require ByteBlower  
  set server [ ByteBlower Server.Add "10.5.5.131"  
  set serviceInfo [ $server ServiceInfo.Get ]  
  puts "[$serverInfo Description.Get]" 

Since: 2.6.0

Definition at line 2695 of file api.tcl.

Method documentation

ByteBlowerServer.ServiceInfo::Connection.Host.Get

Returns the host (either registered name or IP address) used to connect to the ByteBlower server.

Example

1 $serviceInfo Connection.Host.Get

Returns:

byteblower-123.excentis.com

Definition at line 2705 of file api.tcl.

ByteBlowerServer.ServiceInfo::Connection.IPAddress.Get

Returns the IP address used to connect to the ByteBlower server.

Example

1 $serviceInfo Connection.IPAddress.Get

Returns:

192.168.0.2

Definition at line 2715 of file api.tcl.

ByteBlowerServer.ServiceInfo::Connection.PortNumber.Get

Returns the TCP port number of the connected ByteBlower server.

Example

1 $serviceInfo Connection.PortNumber.Get

Returns:

Definition at line 2725 of file api.tcl.

ByteBlowerServer.ServiceInfo::License.Get

Returns the License information for this ByteBlower server.

Deprecated:: Since 2.10

Each physical ByteBlower server (represented by this type of object) has a specific ByteBlower License.

Since: 2.6.0

Returns: ByteBlowerLicense

Example

1 $server License.Get

Returns:

<ByteBlowerLicense object>

Definition at line 2748 of file api.tcl.

ByteBlowerServer.ServiceInfo::MachineID.Get

Returns a unique identifier for the machine where this ByteBlower server service runs on.

The machineID is a unique ID for the machine (the physical server), and generated at install time. If the server is re-installed, a new ID will be generated.

If you have a ByteBlower service and a MeetingPoint service running on the same physical server then will ByteBlowerServiceInfo::MachineID.Get and MeetingPointServiceInfo::MachineID.Get return the same value

Example

1 $serviceInfo MachineID.Get

Returns:

082b73cdd97d96732ba106e758c13d40

Definition at line 2762 of file api.tcl.

ByteBlowerServer.ServiceInfo::Management.IPAddress.Get

Returns all management IP addresses of the connected ByteBlower server.

Since: 2.6.0

Returns: List of management IP addresses

Example

1 $serviceInfo Management.IPAddress.Get

Returns:

192.168.0.2 10.11.12.13

Definition at line 2776 of file api.tcl.

ByteBlowerServer.ServiceInfo::Series.Get

Returns the server series of the connected ByteBlower server.

The server series defines the ByteBlower server hardware and features. As of 2017, the available server series are

1100
1200
1300
2100
2200
3100
3200
4100

Returns: A string '<X>', where <X> is the series value (e.g. 4100).

Example

1 $serviceInfo Series.Get

Returns:

Definition at line 2795 of file api.tcl.

ByteBlowerServer.ServiceInfo::ServiceID.Get

Returns a unique service identifier for this ByteBlower service.

The serviceID is a unique ID for the service ( e.g. ByteBlower) and is generated when the service (ByteBlower) boots for the first time. If you don't re-install the system, the ID will be the same. It's percistent across reboots. A physical server can have other sercices running (e.g. MeetingPoint - see MeetingPoint). With this ID you can identify each service and together with the MachineID you can see if those services are running on the same Physical Server.

a MeetingPoint (MeetingPoint) has also a serviceId (MeetingPoint.ServiceInfo::ServiceID.Get). And that value should be different than this.

Since: 2.6.0

Example

1 $serviceInfo ServiceID.Get

Returns:

ByteBlower:de949dd3-ea45-40cd-8f84-0a2d9ccd6984

Definition at line 2811 of file api.tcl.

ByteBlowerServer.ServiceInfo::Type.Get

Retrieves the type of the ByteBlower service.

Returns: The ByteBlower service type

Example

1 $serviceInfo Type.Get

Returns:

ByteBlower

Definition at line 2823 of file api.tcl.

ByteBlowerServer.ServiceInfo::Version.Get

Returns the software version of the connected ByteBlower server.

Each physical ByteBlower server (represented by this type of object) runs a specific software version. This version is independent from both the ByteBlower API version (seen when loading the package) and the ByteBlower GUI version (shown in the GUI).

Server software is upgraded from the server itself. For more information on this topic, please see this ByteBlower API Knowledgebase: How to: Updating a ByteBlower server in 2.x environment on our Support Portal.

Returns: Software version string of the form '2.<X>.<Y>', where <X> is the feature version number and <Y> is the patch version number.

Example

1 $serviceInfo Version.Get

Returns:

1.1.0

Definition at line 2839 of file api.tcl.

Methods

Class overview

Method documentation