Device

device

type Device implements Node {
  id: ID!
  macAddress: String!
  disabled: Boolean!
  clientId: String
  ip4: String
  ip6: String
  leaseExpiry: GQLTDate
  hostname: String
  nodeDevice: Boolean!
  connectionType: DeviceConnectionTypeEnum!
  dhcpEnabled: Boolean!
  description: String
  position: GQLTJson
  tag: String
  lastSeen: GQLTDate!
  networkProfile: String!
  rateProfile: String
  createdAt: GQLTDate!
  updatedAt: GQLTDate!
  deviceTypeId: ID
  nodeGroupId: ID
  credentialId: ID
  parentId: ID
  userId: ID
  nasId: ID
  type: DeviceType
  parent: Device
  nodeGroup: NodeGroup
  deviceEvents(
    after: String
    first: Int = 0
    before: String
    last: Int = 0
    orderBy: [DeviceEventOrderBy] = []
    where: GQLTQueryDeviceEventWhere
    include: [GQLTDeviceEventIncludeObject] = []
  ): DeviceEventHasManyDeviceEventsList
  children(
    after: String
    first: Int = 0
    before: String
    last: Int = 0
    orderBy: [DeviceOrderBy] = []
    where: GQLTQueryDeviceWhere
    include: [GQLTDeviceIncludeObject] = []
  ): DeviceHasManyChildrenList
  usages(
    after: String
    first: Int = 0
    before: String
    last: Int = 0
    orderBy: [DeviceUsageOrderBy] = []
    where: GQLTQueryDeviceUsageWhere
    include: [GQLTDeviceUsageIncludeObject] = []
  ): DeviceUsageHasManyUsagesList
  users(
    after: String
    first: Int = 0
    before: String
    last: Int = 0
    orderBy: [UserOrderBy] = []
    where: GQLTQueryUserWhere
    include: [GQLTUserIncludeObject] = []
  ): UserBelongsToManyUsersList
  lastUser: User
  credential: Credential
  configHistory(
    after: String
    first: Int = 0
    before: String
    last: Int = 0
    orderBy: [NodeConfigHistoryOrderBy] = []
    where: GQLTQueryNodeConfigHistoryWhere
    include: [GQLTNodeConfigHistoryIncludeObject] = []
  ): NodeConfigHistoryBelongsToManyConfigHistoryList
  configs(
    after: String
    first: Int = 0
    before: String
    last: Int = 0
    orderBy: [DeviceConfigOrderBy] = []
    where: GQLTQueryDeviceConfigWhere
    include: [GQLTDeviceConfigIncludeObject] = []
  ): DeviceConfigBelongsToManyConfigsList
  nodeServices(
    after: String
    first: Int = 0
    before: String
    last: Int = 0
    orderBy: [NodeServiceOrderBy] = []
    where: GQLTQueryNodeServiceWhere
    include: [GQLTNodeServiceIncludeObject] = []
  ): NodeServiceBelongsToManyNodeServicesList
  groups(
    after: String
    first: Int = 0
    before: String
    last: Int = 0
    orderBy: [GroupOrderBy] = []
    where: GQLTQueryGroupWhere
    include: [GQLTGroupIncludeObject] = []
  ): GroupBelongsToManyGroupsList
  mapItems(
    after: String
    first: Int = 0
    before: String
    last: Int = 0
    orderBy: [MapItemOrderBy] = []
    where: GQLTQueryMapItemWhere
    include: [GQLTMapItemIncludeObject] = []
  ): MapItemHasManyMapItemsList
  devicePositions(
    after: String
    first: Int = 0
    before: String
    last: Int = 0
    orderBy: [DevicePositionOrderBy] = []
    where: GQLTQueryDevicePositionWhere
    include: [GQLTDevicePositionIncludeObject] = []
  ): DevicePositionHasManyDevicePositionsList
  nas: Device
  nasClients(
    after: String
    first: Int = 0
    before: String
    last: Int = 0
    orderBy: [DeviceOrderBy] = []
    where: GQLTQueryDeviceWhere
    include: [GQLTDeviceIncludeObject] = []
  ): DeviceHasManyNasClientsList
  nasSessions(
    after: String
    first: Int = 0
    before: String
    last: Int = 0
    orderBy: [DeviceSessionOrderBy] = []
    where: GQLTQueryDeviceSessionWhere
    include: [GQLTDeviceSessionIncludeObject] = []
  ): DeviceSessionHasManyNasSessionsList
  sessions(
    after: String
    first: Int = 0
    before: String
    last: Int = 0
    orderBy: [DeviceSessionOrderBy] = []
    where: GQLTQueryDeviceSessionWhere
    include: [GQLTDeviceSessionIncludeObject] = []
  ): DeviceSessionHasManySessionsList
  auths(
    after: String
    first: Int = 0
    before: String
    last: Int = 0
    orderBy: [DeviceAuthOrderBy] = []
    where: GQLTQueryDeviceAuthWhere
    include: [GQLTDeviceAuthIncludeObject] = []
  ): DeviceAuthHasManyAuthsList
  childConnections(
    after: String
    first: Int = 0
    before: String
    last: Int = 0
    orderBy: [DeviceConnectionOrderBy] = []
    where: GQLTQueryDeviceConnectionWhere
    include: [GQLTDeviceConnectionIncludeObject] = []
  ): DeviceConnectionHasManyChildConnectionsList
  parentConnections(
    after: String
    first: Int = 0
    before: String
    last: Int = 0
    orderBy: [DeviceConnectionOrderBy] = []
    where: GQLTQueryDeviceConnectionWhere
    include: [GQLTDeviceConnectionIncludeObject] = []
  ): DeviceConnectionHasManyParentConnectionsList
  address: Address
  manufacturer: String
  activeDeviceCount: Int
  activeUserCount: Int
  systemStatistics: DeviceSystemStats
  isActive: Boolean
  recentAuthPorts: [DeviceAuthPort]
  authDevices(nasPortId: String): [Device]
}

Fields#

`id` (`ID!`)#

The ID of an object

`macAddress` (`String!`)#

macAddress column

`disabled` (`Boolean!`)#

disabled column

`clientId` (`String`)#

clientId column

`ip4` (`String`)#

ip4 column

`ip6` (`String`)#

ip6 column

`leaseExpiry` (`GQLTDate`)#

leaseExpiry column

`hostname` (`String`)#

hostname column

`nodeDevice` (`Boolean!`)#

nodeDevice column

`connectionType` (`DeviceConnectionTypeEnum!`)#

connectionType column

`dhcpEnabled` (`Boolean!`)#

dhcpEnabled column

`description` (`String`)#

description column

`position` (`GQLTJson`)#

position column

`tag` (`String`)#

tag to assist device matching in custom callingStationId variables

`lastSeen` (`GQLTDate!`)#

`networkProfile` (`String!`)#

networkProfile column

`rateProfile` (`String`)#

rateProfile column

`createdAt` (`GQLTDate!`)#

`updatedAt` (`GQLTDate!`)#

`deviceTypeId` (`ID`)#

The ID of an object

`nodeGroupId` (`ID`)#

The ID of an object

`credentialId` (`ID`)#

The ID of an object

`parentId` (`ID`)#

The ID of an object

`userId` (`ID`)#

The ID of an object

`nasId` (`ID`)#

The ID of an object

`type` (`DeviceType`)#

`parent` (`Device`)#

`nodeGroup` (`NodeGroup`)#

`deviceEvents` (`DeviceEventHasManyDeviceEventsList`)#

after (String)#

If provided it will return results after the provided cursor

first (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the first ${amount} of records.

before (String)#

If provided it will return results before the provided cursor

last (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the last ${amount} of records.

orderBy ([DeviceEventOrderBy])#

If provided this will sort the results by the supplied column and direction

where (GQLTQueryDeviceEventWhere)#
include ([GQLTDeviceEventIncludeObject])#

`children` (`DeviceHasManyChildrenList`)#

after (String)#

If provided it will return results after the provided cursor

first (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the first ${amount} of records.

before (String)#

If provided it will return results before the provided cursor

last (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the last ${amount} of records.

orderBy ([DeviceOrderBy])#

If provided this will sort the results by the supplied column and direction

where (GQLTQueryDeviceWhere)#
include ([GQLTDeviceIncludeObject])#

`usages` (`DeviceUsageHasManyUsagesList`)#

after (String)#

If provided it will return results after the provided cursor

first (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the first ${amount} of records.

before (String)#

If provided it will return results before the provided cursor

last (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the last ${amount} of records.

orderBy ([DeviceUsageOrderBy])#

If provided this will sort the results by the supplied column and direction

where (GQLTQueryDeviceUsageWhere)#
include ([GQLTDeviceUsageIncludeObject])#

`users` (`UserBelongsToManyUsersList`)#

after (String)#

If provided it will return results after the provided cursor

first (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the first ${amount} of records.

before (String)#

If provided it will return results before the provided cursor

last (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the last ${amount} of records.

orderBy ([UserOrderBy])#

If provided this will sort the results by the supplied column and direction

where (GQLTQueryUserWhere)#
include ([GQLTUserIncludeObject])#

`lastUser` (`User`)#

`credential` (`Credential`)#

`configHistory` (`NodeConfigHistoryBelongsToManyConfigHistoryList`)#

after (String)#

If provided it will return results after the provided cursor

first (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the first ${amount} of records.

before (String)#

If provided it will return results before the provided cursor

last (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the last ${amount} of records.

orderBy ([NodeConfigHistoryOrderBy])#

If provided this will sort the results by the supplied column and direction

where (GQLTQueryNodeConfigHistoryWhere)#
include ([GQLTNodeConfigHistoryIncludeObject])#

`configs` (`DeviceConfigBelongsToManyConfigsList`)#

after (String)#

If provided it will return results after the provided cursor

first (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the first ${amount} of records.

before (String)#

If provided it will return results before the provided cursor

last (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the last ${amount} of records.

orderBy ([DeviceConfigOrderBy])#

If provided this will sort the results by the supplied column and direction

where (GQLTQueryDeviceConfigWhere)#
include ([GQLTDeviceConfigIncludeObject])#

`nodeServices` (`NodeServiceBelongsToManyNodeServicesList`)#

after (String)#

If provided it will return results after the provided cursor

first (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the first ${amount} of records.

before (String)#

If provided it will return results before the provided cursor

last (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the last ${amount} of records.

orderBy ([NodeServiceOrderBy])#

If provided this will sort the results by the supplied column and direction

where (GQLTQueryNodeServiceWhere)#
include ([GQLTNodeServiceIncludeObject])#

`groups` (`GroupBelongsToManyGroupsList`)#

after (String)#

If provided it will return results after the provided cursor

first (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the first ${amount} of records.

before (String)#

If provided it will return results before the provided cursor

last (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the last ${amount} of records.

orderBy ([GroupOrderBy])#

If provided this will sort the results by the supplied column and direction

where (GQLTQueryGroupWhere)#
include ([GQLTGroupIncludeObject])#

`mapItems` (`MapItemHasManyMapItemsList`)#

after (String)#

If provided it will return results after the provided cursor

first (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the first ${amount} of records.

before (String)#

If provided it will return results before the provided cursor

last (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the last ${amount} of records.

orderBy ([MapItemOrderBy])#

If provided this will sort the results by the supplied column and direction

where (GQLTQueryMapItemWhere)#
include ([GQLTMapItemIncludeObject])#

`devicePositions` (`DevicePositionHasManyDevicePositionsList`)#

after (String)#

If provided it will return results after the provided cursor

first (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the first ${amount} of records.

before (String)#

If provided it will return results before the provided cursor

last (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the last ${amount} of records.

orderBy ([DevicePositionOrderBy])#

If provided this will sort the results by the supplied column and direction

where (GQLTQueryDevicePositionWhere)#
include ([GQLTDevicePositionIncludeObject])#

`nas` (`Device`)#

`nasClients` (`DeviceHasManyNasClientsList`)#

after (String)#

If provided it will return results after the provided cursor

first (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the first ${amount} of records.

before (String)#

If provided it will return results before the provided cursor

last (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the last ${amount} of records.

orderBy ([DeviceOrderBy])#

If provided this will sort the results by the supplied column and direction

where (GQLTQueryDeviceWhere)#
include ([GQLTDeviceIncludeObject])#

`nasSessions` (`DeviceSessionHasManyNasSessionsList`)#

List all the active nas type devices based from sessions

after (String)#

If provided it will return results after the provided cursor

first (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the first ${amount} of records.

before (String)#

If provided it will return results before the provided cursor

last (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the last ${amount} of records.

orderBy ([DeviceSessionOrderBy])#

If provided this will sort the results by the supplied column and direction

where (GQLTQueryDeviceSessionWhere)#
include ([GQLTDeviceSessionIncludeObject])#

`sessions` (`DeviceSessionHasManySessionsList`)#

List all the active sessions

after (String)#

If provided it will return results after the provided cursor

first (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the first ${amount} of records.

before (String)#

If provided it will return results before the provided cursor

last (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the last ${amount} of records.

orderBy ([DeviceSessionOrderBy])#

If provided this will sort the results by the supplied column and direction

where (GQLTQueryDeviceSessionWhere)#
include ([GQLTDeviceSessionIncludeObject])#

`auths` (`DeviceAuthHasManyAuthsList`)#

List all the authentication being attempted by device

after (String)#

If provided it will return results after the provided cursor

first (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the first ${amount} of records.

before (String)#

If provided it will return results before the provided cursor

last (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the last ${amount} of records.

orderBy ([DeviceAuthOrderBy])#

If provided this will sort the results by the supplied column and direction

where (GQLTQueryDeviceAuthWhere)#
include ([GQLTDeviceAuthIncludeObject])#

`childConnections` (`DeviceConnectionHasManyChildConnectionsList`)#

after (String)#

If provided it will return results after the provided cursor

first (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the first ${amount} of records.

before (String)#

If provided it will return results before the provided cursor

last (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the last ${amount} of records.

orderBy ([DeviceConnectionOrderBy])#

If provided this will sort the results by the supplied column and direction

where (GQLTQueryDeviceConnectionWhere)#
include ([GQLTDeviceConnectionIncludeObject])#

`parentConnections` (`DeviceConnectionHasManyParentConnectionsList`)#

after (String)#

If provided it will return results after the provided cursor

first (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the first ${amount} of records.

before (String)#

If provided it will return results before the provided cursor

last (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the last ${amount} of records.

orderBy ([DeviceConnectionOrderBy])#

If provided this will sort the results by the supplied column and direction

where (GQLTQueryDeviceConnectionWhere)#
include ([GQLTDeviceConnectionIncludeObject])#

`address` (`Address`)#

`manufacturer` (`String`)#

`activeDeviceCount` (`Int`)#

`activeUserCount` (`Int`)#

`systemStatistics` (`DeviceSystemStats`)#

`isActive` (`Boolean`)#

`recentAuthPorts` (`[DeviceAuthPort]`)#

`authDevices` (`[Device]`)#

nasPortId (String)#

Interfaces#

`Node`#

An object with an ID

Fields#

id (ID!)#

macAddress (String!)#

disabled (Boolean!)#

clientId (String)#

ip4 (String)#

ip6 (String)#

leaseExpiry (GQLTDate)#

hostname (String)#

nodeDevice (Boolean!)#

connectionType (DeviceConnectionTypeEnum!)#

dhcpEnabled (Boolean!)#

description (String)#

position (GQLTJson)#

tag (String)#

lastSeen (GQLTDate!)#

networkProfile (String!)#

rateProfile (String)#

createdAt (GQLTDate!)#

updatedAt (GQLTDate!)#

deviceTypeId (ID)#

nodeGroupId (ID)#

credentialId (ID)#

parentId (ID)#

userId (ID)#

nasId (ID)#

type (DeviceType)#

parent (Device)#

nodeGroup (NodeGroup)#

deviceEvents (DeviceEventHasManyDeviceEventsList)#

after (String)#

first (Int)#

before (String)#

last (Int)#

orderBy ([DeviceEventOrderBy])#

where (GQLTQueryDeviceEventWhere)#

include ([GQLTDeviceEventIncludeObject])#

children (DeviceHasManyChildrenList)#

after (String)#

first (Int)#

before (String)#

last (Int)#

orderBy ([DeviceOrderBy])#

where (GQLTQueryDeviceWhere)#

include ([GQLTDeviceIncludeObject])#

usages (DeviceUsageHasManyUsagesList)#

after (String)#

first (Int)#

before (String)#

last (Int)#

orderBy ([DeviceUsageOrderBy])#

where (GQLTQueryDeviceUsageWhere)#

include ([GQLTDeviceUsageIncludeObject])#

users (UserBelongsToManyUsersList)#

after (String)#

first (Int)#

before (String)#

last (Int)#

orderBy ([UserOrderBy])#

where (GQLTQueryUserWhere)#

include ([GQLTUserIncludeObject])#

lastUser (User)#

credential (Credential)#

configHistory (NodeConfigHistoryBelongsToManyConfigHistoryList)#

after (String)#

first (Int)#

before (String)#

last (Int)#

orderBy ([NodeConfigHistoryOrderBy])#

where (GQLTQueryNodeConfigHistoryWhere)#

include ([GQLTNodeConfigHistoryIncludeObject])#

configs (DeviceConfigBelongsToManyConfigsList)#

after (String)#

first (Int)#

before (String)#

last (Int)#

orderBy ([DeviceConfigOrderBy])#

where (GQLTQueryDeviceConfigWhere)#

include ([GQLTDeviceConfigIncludeObject])#

nodeServices (NodeServiceBelongsToManyNodeServicesList)#

`id` (`ID!`)#

`macAddress` (`String!`)#

`disabled` (`Boolean!`)#

`clientId` (`String`)#

`ip4` (`String`)#

`ip6` (`String`)#

`leaseExpiry` (`GQLTDate`)#

`hostname` (`String`)#

`nodeDevice` (`Boolean!`)#

`connectionType` (`DeviceConnectionTypeEnum!`)#

`dhcpEnabled` (`Boolean!`)#

`description` (`String`)#

`position` (`GQLTJson`)#

`tag` (`String`)#

`lastSeen` (`GQLTDate!`)#

`networkProfile` (`String!`)#

`rateProfile` (`String`)#

`createdAt` (`GQLTDate!`)#

`updatedAt` (`GQLTDate!`)#

`deviceTypeId` (`ID`)#

`nodeGroupId` (`ID`)#

`credentialId` (`ID`)#

`parentId` (`ID`)#

`userId` (`ID`)#

`nasId` (`ID`)#

`type` (`DeviceType`)#

`parent` (`Device`)#

`nodeGroup` (`NodeGroup`)#

`deviceEvents` (`DeviceEventHasManyDeviceEventsList`)#

`after` (`String`)#

`first` (`Int`)#

`before` (`String`)#

`last` (`Int`)#

`orderBy` (`[DeviceEventOrderBy]`)#

`where` (`GQLTQueryDeviceEventWhere`)#

`include` (`[GQLTDeviceEventIncludeObject]`)#

`children` (`DeviceHasManyChildrenList`)#

`after` (`String`)#

`first` (`Int`)#

`before` (`String`)#

`last` (`Int`)#

`orderBy` (`[DeviceOrderBy]`)#

`where` (`GQLTQueryDeviceWhere`)#

`include` (`[GQLTDeviceIncludeObject]`)#

`usages` (`DeviceUsageHasManyUsagesList`)#

`after` (`String`)#

`first` (`Int`)#

`before` (`String`)#

`last` (`Int`)#

`orderBy` (`[DeviceUsageOrderBy]`)#

`where` (`GQLTQueryDeviceUsageWhere`)#

`include` (`[GQLTDeviceUsageIncludeObject]`)#

`users` (`UserBelongsToManyUsersList`)#

`after` (`String`)#

`first` (`Int`)#

`before` (`String`)#

`last` (`Int`)#

`orderBy` (`[UserOrderBy]`)#

`where` (`GQLTQueryUserWhere`)#

`include` (`[GQLTUserIncludeObject]`)#

`lastUser` (`User`)#

`credential` (`Credential`)#

`configHistory` (`NodeConfigHistoryBelongsToManyConfigHistoryList`)#

`after` (`String`)#

`first` (`Int`)#

`before` (`String`)#

`last` (`Int`)#

`orderBy` (`[NodeConfigHistoryOrderBy]`)#

`where` (`GQLTQueryNodeConfigHistoryWhere`)#

`include` (`[GQLTNodeConfigHistoryIncludeObject]`)#

`configs` (`DeviceConfigBelongsToManyConfigsList`)#

`after` (`String`)#

`first` (`Int`)#

`before` (`String`)#

`last` (`Int`)#

`orderBy` (`[DeviceConfigOrderBy]`)#

`where` (`GQLTQueryDeviceConfigWhere`)#

`include` (`[GQLTDeviceConfigIncludeObject]`)#

`nodeServices` (`NodeServiceBelongsToManyNodeServicesList`)#

`after` (`String`)#