All Classes Namespaces Files Functions Pages
MeetingPoint.ServiceInfo Class Reference

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 MeetingPoint. More...
 
 Connection.IPAddress.Get
 Returns the IP address used to connect to the meeting point. More...
 
 Connection.PortNumber.Get
 Returns the TCP port number of the Meeting Point service daemon. More...
 
 Description.Get
 Returns a textual description of the object.
 
 License.Get
 Returns a license object for the MeetingPoint. More...
 
 MachineID.Get
 Returns a unique identifier for the machine where this Meeting Point service runs on. More...
 
 Management.IPAddress.Get
 Returns all management IP addresses of the meeting point. More...
 
 Parent.Get
 Returns the parent object.
 
 Series.Get
 Returns the series of the connected Meeting Point. More...
 
 ServiceID.Get
 Returns a unique service identifier for this Meeting Point. More...
 
 Type.Get
 Retrieves the type of the ByteBlower service. More...
 
 Version.Get
 Returns the software version of the Meeting Point service daemon. 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
1 package require ByteBlower
2  set meetingpoint [ ByteBlower MeetingPoint.Add "10.5.5.131"
3  set serviceInfo [ $meetingpoint ServiceInfo.Get ]
4  puts "[$serverInfo Description.Get]"
Since
2.6.0

Definition at line 17539 of file api.tcl.

Method documentation

MeetingPoint.ServiceInfo::Connection.Host.Get

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

Example
1 $serviceInfo Connection.Host.Get

Returns:

byteblower-123.excentis.com 

Definition at line 17549 of file api.tcl.

MeetingPoint.ServiceInfo::Connection.IPAddress.Get

Returns the IP address used to connect to the meeting point.

Example
1 $serviceInfo Connection.IPAddress.Get

Returns:

192.168.0.2 

Definition at line 17559 of file api.tcl.

MeetingPoint.ServiceInfo::Connection.PortNumber.Get

Returns the TCP port number of the Meeting Point service daemon.

Example
1 $serviceInfo Connection.PortNumber.Get

Returns:

9100 

Definition at line 17569 of file api.tcl.

MeetingPoint.ServiceInfo::License.Get

Returns a license object for the MeetingPoint.

Deprecated:
Since 2.10

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

Returns
MeetingPointLicense
Example
1 $serviceInfo License.Get

Returns:

<MeetingPointLicense object> 

Definition at line 17590 of file api.tcl.

MeetingPoint.ServiceInfo::MachineID.Get

Returns a unique identifier for the machine where this Meeting Point 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 17604 of file api.tcl.

MeetingPoint.ServiceInfo::Management.IPAddress.Get

Returns all management IP addresses of the meeting point.

Returns
List of management IP addresses
Example
1 $serviceInfo Management.IPAddress.Get

Returns:

192.168.0.2 10.11.12.13 

Definition at line 17616 of file api.tcl.

MeetingPoint.ServiceInfo::Series.Get

Returns the series of the connected Meeting Point.

The Meeting Point series defines the server hardware and features. As of 2017, the available series code is 1000.

Returns
A string '<X>', where <X> is the series value (e.g. 1000).
Example
1 $serviceInfo Series.Get

Returns:

1000 

Definition at line 17635 of file api.tcl.

MeetingPoint.ServiceInfo::ServiceID.Get

Returns a unique service identifier for this Meeting Point.

Since Meeting Point version 1.1.0,

The serviceID is a unique ID for the service ( e.g. MeetingPoint) and is generated when the service (MeetingPoint) boots for the first time. If you don't re-install the system, the ID will be the same. A physical server can have other sercices running (e.g. ByteBlower - see ByteBlowerServer). 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 ByteBlower service (ByteBlowerServer.ServiceInfo) has also a serviceId (ByteBlowerServer.ServiceInfo::ServiceID.Get). And this should be different than this of the MeetingPoint.

Example
1 $serviceInfo ServiceID.Get

Returns:

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

Definition at line 17651 of file api.tcl.

MeetingPoint.ServiceInfo::Type.Get

Retrieves the type of the ByteBlower service.

Returns
The ByteBlower service type
Example
1 $serviceInfo Type.Get

Returns:

MeetingPoint 

Definition at line 17663 of file api.tcl.

MeetingPoint.ServiceInfo::Version.Get

Returns the software version of the Meeting Point service daemon.

Example
1 $serviceInfo Version.Get

Returns:

1.1.0 

Definition at line 17673 of file api.tcl.