DataServersList
The
DataServersList
item returns information about all of the data servers defined for the equipment database.This table shows the input and output formats for this item.
Input Format | Request: DataServersList | ||
Output Format | The DataServersList item returns in this format: | ||
<DataServersList> | is | <ServerList> | |
<ServerList> | is | <NullList> | <DataServersList> | |
<DataServersList> | is | <Server> | <Server> \t <DataServersList> | |
where: | |||
<Server> | is | <DataServerName> \t <WatchdogProtocol> \t <Location> \t <RemoteNodeName> \t <Protocol> \t <ServerIdentifier> \t <ConfigString1> \t <ConfigString2> \t <ConfigString3> \t <ConfigString4> \t <LocaleID> \t <BadValueString> \crlf | |
where: | |||
Field Name | Format | Description | |
<DataServerName> | ASCII - String | Configured name of the data server. | |
<WatchdogProtocol> | ASCII - String | Indicates configuration option in the equipment database: OPC: Either ENHANCED or STANDARD, indicating configured behavior in area model. CIP: Unused (<sp>) FTD: Either ENHANCED or STANDARD, indicating configured behavior in area model. | |
<Location> | ASCII - String | Indicates configuration option in the equipment database: OPC: Either LOCAL or REMOTE, indicating configuration of data server in area model. CIP: LOCAL (only possible selection for CIP server) FTD: LOCAL (only possible selection for FTD server) | |
<RemoteNodeName> | ASCII – String | Configured name of the remote node: OPC: If <Location> is REMOTE, this is the remote node’s configured name where the OPC data server is located. If <Location> is LOCAL, this field is unused (<sp>). CIP: Unused (<sp>) FTD: Unused (<sp>) | |
<Protocol> | ASCII – String | Data server type selected in the equipment database. Legal values are OPC, CIP, and FTD. | |
<ServerIdentifier> | ASCII – String | Protocol-specific configuration string exposed: OPC: An 128-bit GUID indicating the ClassID of the OPC server. CIP: The string constant "FactoryTalk Linx". FTD: The Area Path used in establishing a connection to the FTD server. | |
<ConfigString1> | ASCII – String | Protocol-specific configuration string exposed: OPC: The data server’s configured watchdog read item access path. CIP: Controller Path FTD: The data server’s configured watchdog read item access path. | |
<ConfigString2> | ASCII – String | Protocol-specific configuration string exposed: OPC: The data server’s configured watchdog read item name. CIP: Controller Type FTD: The data server’s configured watchdog read item name. | |
<ConfigString3> | ASCII – String | Protocol-specific configuration string exposed: OPC: The data server’s configured watchdog write item name. CIP: Unused (<sp>). FTD: The data server’s configured watchdog write item access path. | |
<ConfigString4> | ASCII – String | Protocol-specific configuration string exposed: OPC: The data server’s configured watchdog write item name. CIP: Unused (<sp>). FTD: The data server’s configured watchdog write item name. | |
<LocaleID> | ASCII – Integer | This is a legacy field no longer used. | |
<BadValueString> | ASCII – String | This is a legacy field no longer used. | |
This table shows an example of the return on this request.
TIP:
A request on
object.GetItem(DataServersList)
could return:INSTRUCTIONBASEDSERVER \t STANDARD \t LOCAL \t \t OPC \t {473B5480-888D-11d2-811B-0800363B4A03} \t INSTRUCTIONS \t WATCHDOG \t \t \t \t \crlf
OPC_SIM \t STANDARD \t LOCAL \t \t OPC \t
{3203642A-F66D-11d1-AD6C-00A024386728} \t PHASES \t WATCHDOG \t \t \t \t \crlf
Provide Feedback