airdress.agent_device.*

The events in the airdress.agent_device family. How to read a section, and what each audience means, is on the event reference page.

airdress.agent_device.refused

Owner warn Functions

An agent device reached a route outside what an agent may, and was refused.

Audience: owner. About the airdress as a whole. Only the owner receives it: the owner’s devices and the owner’s subscriptions.

Where it goes

• The operator’s journal, as one log line at this level, and the event log, where airdress events tail reads it.
• Subscriptions that name it, within its audience.
• Functions bound to this operator’s events (source: operator).

Versions

• Version 1: first carried by operator v0.1.138.

Data

Field	Type	Required	Description
method	string	yes
path	string	yes	The matched route template, never the concrete path.

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "An agent device reached a route outside what an agent may, and was refused.",
  "properties": {
    "method": {
      "type": "string"
    },
    "path": {
      "description": "The matched route template, never the concrete path.",
      "type": "string"
    }
  },
  "required": [
    "method",
    "path"
  ],
  "title": "AgentDeviceRefused",
  "type": "object"
}

airdress.agent_device.renewed

Owner info Functions

An agent device’s delegation was renewed in place by an approved join request.

Audience: owner. About the airdress as a whole. Only the owner receives it: the owner’s devices and the owner’s subscriptions.

Where it goes

• The operator’s journal, as one log line at this level, and the event log, where airdress events tail reads it.
• Subscriptions that name it, within its audience.
• Functions bound to this operator’s events (source: operator).

Versions

• Version 1: first carried by operator v0.1.138.

Data

Field	Type	Required	Description
airdress	string	yes
enrollment_id	string (uuid)	yes
request_id	string (uuid)	yes

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "An agent device's delegation was renewed in place by an approved join request.",
  "properties": {
    "airdress": {
      "type": "string"
    },
    "enrollment_id": {
      "format": "uuid",
      "type": "string"
    },
    "request_id": {
      "format": "uuid",
      "type": "string"
    }
  },
  "required": [
    "airdress",
    "enrollment_id",
    "request_id"
  ],
  "title": "AgentDeviceRenewed",
  "type": "object"
}

airdress.agent_device.resumed

Owner info Functions

The agent-devices switch went on and count suspended agent devices resumed.

Audience: owner. About the airdress as a whole. Only the owner receives it: the owner’s devices and the owner’s subscriptions.

Where it goes

• The operator’s journal, as one log line at this level, and the event log, where airdress events tail reads it.
• Subscriptions that name it, within its audience.
• Functions bound to this operator’s events (source: operator).

Versions

• Version 1: first carried by operator v0.1.138.

Data

Field	Type	Required	Description
count	integer (uint)	yes

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "The agent-devices switch went on and `count` suspended agent devices resumed.",
  "properties": {
    "count": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "count"
  ],
  "title": "AgentDevicesResumed",
  "type": "object"
}

airdress.agent_device.suspended

Owner warn Functions

The agent-devices switch went off and count agent devices were suspended, not revoked.

Audience: owner. About the airdress as a whole. Only the owner receives it: the owner’s devices and the owner’s subscriptions.

Where it goes

• The operator’s journal, as one log line at this level, and the event log, where airdress events tail reads it.
• Subscriptions that name it, within its audience.
• Functions bound to this operator’s events (source: operator).

Versions

• Version 1: first carried by operator v0.1.138.

Data

Field	Type	Required	Description
count	integer (uint)	yes

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "The agent-devices switch went off and `count` agent devices were suspended, not revoked.",
  "properties": {
    "count": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "count"
  ],
  "title": "AgentDevicesSuspended",
  "type": "object"
}