The RestRoute Class
The RestRoute class provides status for REST Route Supervisor instances in anynode. All properties are read-only. For each configured REST Route Supervisor, one class instance exists. The property ObjectRecordName has the key qualifier and uniquely identifies an instance.
Some WMI queries are only available starting from anynode version 4.16.(Check out available WMI queries with the PowerShell command below).
To display all available contents of the RestRoute class locally without credentials, you can use the following command:
Get-WmiObject -Namespace "root\TESYSTEMS\anynode" -Class "RestRoute"
-Namespace "root\TESYSTEMS\anynode" : Specifies the WMI namespace
for anynode.
-Class "RestRoute" : Selects the "RestRoute" class to retrieve its contents.
RestRoute Class Properties
The table below lists the properties of the 'RestRoute' class in alphabetical order. All properties are read-only.
Property: BaseUri
Type: string
Description: The property provides the base URI of the HTTP server.
Property: Comment
Type: string
Description: The property provides the symbolic name of the REST Route Supervisor from configuration.
Property: HttpInState
Type: uint32
Description: The property indicates whether the web server is reachable. Valid values are:
-
1: Available -
2: DnsFailed -
3: TcpChannelFailed -
4: TlsChannelFailed
Property: Index
Type: uint32
Description: The property provides the numeric index of the instance (1 .. number of configured REST Route Supervisors).
Property: LastQueryResponseCode
Type: uint32
Description: The property provides the HTTP response code of the last route request.
Property: NetworkObjectRecordName
Type: string
Description: The property provides the identifier of the network interface used by this supervisor.
Property: NetworkUp
Type: uint32
Description: The property indicates whether the network interface is active. Valid values are:
-
1: Up -
2: Down
Property: ObjectRecordName
Type: string
Description: The property provides the unique object identifier from configuration. It has the key attribute and identifies the instance.
Property: RoutingType
Type: uint32
Description: The property provides the routing type. Valid values are:
-
1: RequestRoute -
2: NotifyAccept -
3: NotifyIgnore
Property: UserName
Type: string
Description: The property provides the username for HTTP server authentication (may be an empty string).
Property: ValidationInterval
Type: uint32
Description: The property provides the interval in seconds for status refresh; 0 means no refresh.