Name | Description | Type | Additional information |
---|---|---|---|
AgentName |
The name of the Agent. This is the unique identifier for a SIM |
string |
Required Matching regular expression pattern: ^[A-z0-9_]+$ |
NetworkStatus |
The connection status of the Agent to the Asavie Passbridge core. It can have one of the following values:-<br/> disconnected = 0 connected = 1 activation = 10 |
NetworkStatusValues |
None. |
Enabled |
Gets and sets whether the Agent is enabled or disabled on the Passbridge Core |
boolean |
None. |
AgentTunnel |
Gets the name of the Agent tunnel to the Passbridge core. |
string |
None. |
WANAdapter |
Gets and sets the IP address of the Agent. |
string |
Required |
Routes |
Gets the routes that the Agent can see. |
string |
None. |
Info |
Gets the list of details collected by the Agent about its host environment |
string |
None. |
Services |
Gets the list of services collected by the Agent about its host environment |
string |
None. |
CertCname |
Gets the Common name of the Agent certificate. Every Agent is authenticated to the Passbridge core via x509 certificate. |
string |
None. |
InstallKey |
Gets the installation key required to complete an Agent installation |
string |
None. |
Version |
The version of the Agent actor. Every time a change is made to the Agent its version is incremented. |
integer |
None. |
ActorStatus |
The Agent actor status. Every resource in the api is represented by an actor. The actor status represents the health of the resource. The ActorStatus can be one of the following values:-<br/> stable = 0 /* everything is ok */ pending = 1 /* an operation is long running */ stalled = 10 /* an unrecoverable error has occurred that will require support desk intervention */ |
ActorStatusValues |
None. |
Status | StatusValues |
None. |
|
ContextSettings |
Gets and sets optional settings required to set up the Agent. |
Collection of Setting |
None. |