Documentation
¶
Index ¶
- Constants
- type CoordinatesXY
- type DeviceFirmware
- type DeviceIdentification
- type DeviceInterfaceSchema
- type DeviceMeta
- type DeviceOverview
- type DeviceStatistics
- type DeviceStatusOverview
- type DeviceUpgrade
- type Error
- type InterfaceIdentification
- func (m *InterfaceIdentification) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *InterfaceIdentification) MarshalBinary() ([]byte, error)
- func (m *InterfaceIdentification) UnmarshalBinary(b []byte) error
- func (m *InterfaceIdentification) Validate(formats strfmt.Registry) error
- type InterfaceStatistics
- type InterfaceStatus
- type LatestBackup
- type ListOfCoordinates
- type Semver
- type SemverVersion
- type Site
Constants ¶
const ( // DeviceIdentificationCategoryOptical captures enum value "optical" DeviceIdentificationCategoryOptical string = "optical" // DeviceIdentificationCategoryWired captures enum value "wired" DeviceIdentificationCategoryWired string = "wired" // DeviceIdentificationCategoryWireless captures enum value "wireless" DeviceIdentificationCategoryWireless string = "wireless" // DeviceIdentificationCategoryAccessories captures enum value "accessories" DeviceIdentificationCategoryAccessories string = "accessories" )
const ( // DeviceIdentificationRoleRouter captures enum value "router" DeviceIdentificationRoleRouter string = "router" // DeviceIdentificationRoleSwitch captures enum value "switch" DeviceIdentificationRoleSwitch string = "switch" // DeviceIdentificationRoleGpon captures enum value "gpon" DeviceIdentificationRoleGpon string = "gpon" // DeviceIdentificationRoleAp captures enum value "ap" DeviceIdentificationRoleAp string = "ap" // DeviceIdentificationRoleStation captures enum value "station" DeviceIdentificationRoleStation string = "station" // DeviceIdentificationRoleOther captures enum value "other" DeviceIdentificationRoleOther string = "other" // DeviceIdentificationRoleUps captures enum value "ups" DeviceIdentificationRoleUps string = "ups" // DeviceIdentificationRoleServer captures enum value "server" DeviceIdentificationRoleServer string = "server" // DeviceIdentificationRoleWireless captures enum value "wireless" DeviceIdentificationRoleWireless string = "wireless" // DeviceIdentificationRoleConvertor captures enum value "convertor" DeviceIdentificationRoleConvertor string = "convertor" // DeviceIdentificationRoleGateway captures enum value "gateway" DeviceIdentificationRoleGateway string = "gateway" )
const ( // DeviceIdentificationStatusActive captures enum value "active" DeviceIdentificationStatusActive string = "active" // DeviceIdentificationStatusConnecting captures enum value "connecting" DeviceIdentificationStatusConnecting string = "connecting" // DeviceIdentificationStatusDiscovered captures enum value "discovered" DeviceIdentificationStatusDiscovered string = "discovered" // DeviceIdentificationStatusInactive captures enum value "inactive" DeviceIdentificationStatusInactive string = "inactive" // DeviceIdentificationStatusDisabled captures enum value "disabled" DeviceIdentificationStatusDisabled string = "disabled" // DeviceIdentificationStatusDisconnected captures enum value "disconnected" DeviceIdentificationStatusDisconnected string = "disconnected" DeviceIdentificationStatusUnauthorized string = "unauthorized" // DeviceIdentificationStatusProposed captures enum value "proposed" DeviceIdentificationStatusProposed string = "proposed" // DeviceIdentificationStatusUnknown captures enum value "unknown" DeviceIdentificationStatusUnknown string = "unknown" // DeviceIdentificationStatusUnplaced captures enum value "unplaced" DeviceIdentificationStatusUnplaced string = "unplaced" // DeviceIdentificationStatusCustom captures enum value "custom" DeviceIdentificationStatusCustom string = "custom" )
const ( // SiteStatusActive captures enum value "active" SiteStatusActive string = "active" // SiteStatusDisconnected captures enum value "disconnected" SiteStatusDisconnected string = "disconnected" // SiteStatusInactive captures enum value "inactive" SiteStatusInactive string = "inactive" )
const ( // SiteTypeSite captures enum value "site" SiteTypeSite string = "site" // SiteTypeEndpoint captures enum value "endpoint" SiteTypeEndpoint string = "endpoint" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CoordinatesXY ¶ added in v0.2.0
type CoordinatesXY struct { // x X float64 `json:"x,omitempty"` // y Y float64 `json:"y,omitempty"` }
CoordinatesXY coordinates x y
swagger:model CoordinatesXY.
func (*CoordinatesXY) ContextValidate ¶ added in v0.2.0
ContextValidate validates this coordinates x y based on context it is used
func (*CoordinatesXY) MarshalBinary ¶ added in v0.2.0
func (m *CoordinatesXY) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CoordinatesXY) UnmarshalBinary ¶ added in v0.2.0
func (m *CoordinatesXY) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeviceFirmware ¶
type DeviceFirmware struct { // Is firmware compatible with UNMS // Required: true Compatible *bool `json:"compatible"` // Current firmware version. // Required: true Current *string `json:"current"` // Latest known firmware version. // Required: true Latest *string `json:"latest"` // semver Semver *Semver `json:"semver,omitempty"` }
DeviceFirmware device firmware
swagger:model DeviceFirmware
func (*DeviceFirmware) ContextValidate ¶
ContextValidate validate this device firmware based on the context it is used
func (*DeviceFirmware) MarshalBinary ¶
func (m *DeviceFirmware) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceFirmware) UnmarshalBinary ¶
func (m *DeviceFirmware) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeviceIdentification ¶
type DeviceIdentification struct { // Device is added to UNMS. Authorized bool `json:"authorized,omitempty"` // category // Enum: [optical wired wireless accessories] Category string `json:"category,omitempty"` // UNMS device alias or real name. DisplayName string `json:"displayName,omitempty"` // In SemVer format. FirmwareVersion string `json:"firmwareVersion,omitempty"` // hostname Hostname string `json:"hostname,omitempty"` // Device ID. // Example: f7ac9cad-ea28-4390-93c8-7add010e8ee3 // Required: true ID *string `json:"id"` // Custom IP address in IPv4 or IPv6 format. // Example: 192.168.1.22 IP string `json:"ip,omitempty"` // mac // Pattern: ^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$|^([0-9a-fA-F]){12}$ Mac string `json:"mac,omitempty"` // Short names, for example UF-OLT. Model string `json:"model,omitempty"` // Full names, for example UFiber OLT. ModelName string `json:"modelName,omitempty"` // name Name string `json:"name,omitempty"` // Short name, for example e600. PlatformID string `json:"platformId,omitempty"` // platform name PlatformName string `json:"platformName,omitempty"` // role // Enum: [router switch gpon ap station other ups server wireless convertor gateway] Role string `json:"role,omitempty"` // serial number SerialNumber string `json:"serialNumber,omitempty"` // site Site *Site `json:"site,omitempty"` // started // Format: date-time Started strfmt.DateTime `json:"started,omitempty"` // Status of the station. // Example: active // Enum: [active connecting discovered inactive disabled disconnected unauthorized proposed unknown unplaced custom] Status string `json:"status,omitempty"` // type Type string `json:"type,omitempty"` // updated // Format: date-time Updated strfmt.DateTime `json:"updated,omitempty"` // wan interface Id WanInterfaceID string `json:"wanInterfaceId,omitempty"` }
DeviceIdentification Read-only identification attributes.
swagger:model DeviceIdentification
func (*DeviceIdentification) ContextValidate ¶
ContextValidate validate this device identification based on the context it is used
func (*DeviceIdentification) MarshalBinary ¶
func (m *DeviceIdentification) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceIdentification) UnmarshalBinary ¶
func (m *DeviceIdentification) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeviceInterfaceSchema ¶
type DeviceInterfaceSchema struct { // can display statistics // Example: true CanDisplayStatistics bool `json:"canDisplayStatistics,omitempty"` // enabled // Example: true Enabled bool `json:"enabled,omitempty"` // identification // Required: true Identification *InterfaceIdentification `json:"identification"` // speed // Example: auto // Pattern: ^autodetect|auto|\d+-(half|full)$ Speed string `json:"speed,omitempty"` // statistics Statistics *InterfaceStatistics `json:"statistics,omitempty"` // status Status *InterfaceStatus `json:"status,omitempty"` }
DeviceInterfaceSchema device interface schema
swagger:model DeviceInterfaceSchema
func (*DeviceInterfaceSchema) ContextValidate ¶
ContextValidate validate this device interface schema based on the context it is used
func (*DeviceInterfaceSchema) MarshalBinary ¶
func (m *DeviceInterfaceSchema) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceInterfaceSchema) UnmarshalBinary ¶
func (m *DeviceInterfaceSchema) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeviceMeta ¶
type DeviceMeta struct { // alias // Max Length: 30 Alias string `json:"alias,omitempty"` // Custom IP address in IPv4 or IPv6 format. // Example: 192.168.1.22 CustomIPAddress string `json:"customIpAddress,omitempty"` // failed message decryption // Required: true FailedMessageDecryption *bool `json:"failedMessageDecryption"` // maintenance // Required: true Maintenance *bool `json:"maintenance"` // note // Max Length: 300 Note string `json:"note,omitempty"` // restart timestamp // Example: 2018-11-14T15:20:32.004Z // Required: true // Format: date-time RestartTimestamp *strfmt.DateTime `json:"restartTimestamp"` }
DeviceMeta device meta
swagger:model DeviceMeta
func (*DeviceMeta) ContextValidate ¶
ContextValidate validates this device meta based on context it is used
func (*DeviceMeta) MarshalBinary ¶
func (m *DeviceMeta) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceMeta) UnmarshalBinary ¶
func (m *DeviceMeta) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeviceOverview ¶
type DeviceOverview struct { // battery capacity BatteryCapacity float64 `json:"batteryCapacity,omitempty"` // battery time BatteryTime float64 `json:"batteryTime,omitempty"` // Nullable property in milliamperes. BiasCurrent float64 `json:"biasCurrent,omitempty"` // TRUE if device can be upgraded. CanUpgrade bool `json:"canUpgrade,omitempty"` // channel width ChannelWidth float64 `json:"channelWidth,omitempty"` // Current cpu load. CPU float64 `json:"cpu,omitempty"` // created at // Format: date-time CreatedAt strfmt.DateTime `json:"createdAt,omitempty"` // Nullable property in meters. Distance float64 `json:"distance,omitempty"` // downlink capacity DownlinkCapacity int64 `json:"downlinkCapacity,omitempty"` // Nullable prop; current frequency (only for airmax devices). Frequency float64 `json:"frequency,omitempty"` // TRUE if device is in location mode. IsLocateRunning bool `json:"isLocateRunning,omitempty"` // Last seen timestamp in ISO format. // Example: 2018-11-14T15:20:32.004Z // Format: date-time LastSeen strfmt.DateTime `json:"lastSeen,omitempty"` // power status PowerStatus float64 `json:"powerStatus,omitempty"` // Current memory usage. RAM float64 `json:"ram,omitempty"` // Theoretical max remote signal level. // Example: -55 RemoteSignalMax float64 `json:"remoteSignalMax,omitempty"` // TRUE if device is running on battery RunningOnBattery bool `json:"runningOnBattery,omitempty"` // Nullable prop; current signal level (only for airmax devices), for example -55 dBm. // Example: -55 Signal float64 `json:"signal,omitempty"` // Theoretical max local signal level. // Example: -55 SignalMax float64 `json:"signalMax,omitempty"` // Count of stations (only for airmax and aircube). StationsCount float64 `json:"stationsCount,omitempty"` // Read-only value generated by UNMS. Status string `json:"status,omitempty"` // temperature Temperature float64 `json:"temperature,omitempty"` // theoretical downlink capacity TheoreticalDownlinkCapacity int64 `json:"theoreticalDownlinkCapacity,omitempty"` // theoretical max downlink capacity TheoreticalMaxDownlinkCapacity int64 `json:"theoreticalMaxDownlinkCapacity,omitempty"` // theoretical max uplink capacity TheoreticalMaxUplinkCapacity int64 `json:"theoreticalMaxUplinkCapacity,omitempty"` // theoretical uplink capacity TheoreticalUplinkCapacity int64 `json:"theoreticalUplinkCapacity,omitempty"` // transmit power TransmitPower float64 `json:"transmitPower,omitempty"` // uplink capacity UplinkCapacity int64 `json:"uplinkCapacity,omitempty"` // Uptime in seconds. Uptime float64 `json:"uptime,omitempty"` // System input voltage in V. Voltage float64 `json:"voltage,omitempty"` // wireless mode WirelessMode string `json:"wirelessMode,omitempty"` }
DeviceOverview Read-only basic device/client overview attributes.
swagger:model DeviceOverview
func (*DeviceOverview) ContextValidate ¶
ContextValidate validates this device overview based on context it is used
func (*DeviceOverview) MarshalBinary ¶
func (m *DeviceOverview) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceOverview) UnmarshalBinary ¶
func (m *DeviceOverview) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeviceStatistics ¶ added in v0.2.0
type DeviceStatistics struct { // ping Ping ListOfCoordinates `json:"ping,omitempty"` }
DeviceStatistics device statistics
swagger:model DeviceStatistics
func (*DeviceStatistics) ContextValidate ¶ added in v0.2.0
ContextValidate validate this device statistics based on the context it is used
func (*DeviceStatistics) MarshalBinary ¶ added in v0.2.0
func (m *DeviceStatistics) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceStatistics) UnmarshalBinary ¶ added in v0.2.0
func (m *DeviceStatistics) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeviceStatusOverview ¶
type DeviceStatusOverview struct { // enabled // Required: true Enabled *bool `json:"enabled"` // firmware Firmware *DeviceFirmware `json:"firmware,omitempty"` // identification Identification *DeviceIdentification `json:"identification,omitempty"` // interfaces Interfaces []*DeviceInterfaceSchema `json:"interfaces"` // Custom IP address in IPv4 or IPv6 format. // Example: 192.168.1.22 // Required: true IPAddress *string `json:"ipAddress"` // latest backup LatestBackup *LatestBackup `json:"latestBackup,omitempty"` // meta Meta *DeviceMeta `json:"meta,omitempty"` // mode Mode string `json:"mode,omitempty"` // overview Overview *DeviceOverview `json:"overview,omitempty"` // upgrade Upgrade *DeviceUpgrade `json:"upgrade,omitempty"` }
DeviceStatusOverview device status overview
swagger:model DeviceStatusOverview
func (*DeviceStatusOverview) ContextValidate ¶
ContextValidate validate this device status overview based on the context it is used
func (*DeviceStatusOverview) MarshalBinary ¶
func (m *DeviceStatusOverview) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceStatusOverview) UnmarshalBinary ¶
func (m *DeviceStatusOverview) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeviceUpgrade ¶
type DeviceUpgrade struct { // firmware // Required: true Firmware *SemverVersion `json:"firmware"` // progress // Required: true Progress *float64 `json:"progress"` // status // Required: true Status *string `json:"status"` }
DeviceUpgrade device upgrade
swagger:model DeviceUpgrade
func (*DeviceUpgrade) ContextValidate ¶
ContextValidate validate this device upgrade based on the context it is used
func (*DeviceUpgrade) MarshalBinary ¶
func (m *DeviceUpgrade) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceUpgrade) UnmarshalBinary ¶
func (m *DeviceUpgrade) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Error ¶
type Error struct { // error // Required: true Error *string `json:"error"` // message Message string `json:"message,omitempty"` // status code // Required: true // Maximum: 599 // Minimum: 400 StatusCode *float64 `json:"statusCode"` // validation Validation interface{} `json:"validation,omitempty"` }
Error error
swagger:model Error
func (*Error) ContextValidate ¶
ContextValidate validates this error based on context it is used
func (*Error) MarshalBinary ¶
MarshalBinary interface implementation
func (*Error) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type InterfaceIdentification ¶
type InterfaceIdentification struct { // Nullable string. // Example: Uplink Description *string `json:"description,omitempty"` // Computed display name from name and description // Example: eth0 DisplayName string `json:"displayName,omitempty"` // mac // Example: fc:ec:da:03:bb:a8 // Pattern: ^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$|^([0-9a-fA-F]){12}$ Mac string `json:"mac,omitempty"` // Interface name. // Example: eth0 Name string `json:"name,omitempty"` // Physical port position. // Example: 0 Position int64 `json:"position,omitempty"` // type // Example: eth Type string `json:"type,omitempty"` }
InterfaceIdentification interface identification
swagger:model InterfaceIdentification
func (*InterfaceIdentification) ContextValidate ¶
func (m *InterfaceIdentification) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this interface identification based on context it is used
func (*InterfaceIdentification) MarshalBinary ¶
func (m *InterfaceIdentification) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*InterfaceIdentification) UnmarshalBinary ¶
func (m *InterfaceIdentification) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type InterfaceStatistics ¶
type InterfaceStatistics struct { // dropped // Example: 0 Dropped float64 `json:"dropped,omitempty"` // errors // Example: 0 Errors float64 `json:"errors,omitempty"` // poe power // Example: 736 PoePower float64 `json:"poePower,omitempty"` // rxbytes // Example: 7487858302 Rxbytes float64 `json:"rxbytes,omitempty"` // rxrate // Example: 3440 Rxrate float64 `json:"rxrate,omitempty"` // txbytes // Example: 368737600 Txbytes float64 `json:"txbytes,omitempty"` // txrate // Example: 736 Txrate float64 `json:"txrate,omitempty"` }
InterfaceStatistics interface statistics
swagger:model InterfaceStatistics
func (*InterfaceStatistics) ContextValidate ¶
ContextValidate validates this interface statistics based on context it is used
func (*InterfaceStatistics) MarshalBinary ¶
func (m *InterfaceStatistics) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*InterfaceStatistics) UnmarshalBinary ¶
func (m *InterfaceStatistics) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type InterfaceStatus ¶
type InterfaceStatus struct { // current speed // Example: 1000-full CurrentSpeed string `json:"currentSpeed,omitempty"` // description // Example: 1 Gbps - Full Duplex Description string `json:"description,omitempty"` // plugged // Example: true Plugged bool `json:"plugged,omitempty"` // speed // Example: auto Speed string `json:"speed,omitempty"` // status // Example: active Status string `json:"status,omitempty"` }
InterfaceStatus interface status
swagger:model InterfaceStatus
func (*InterfaceStatus) ContextValidate ¶
ContextValidate validates this interface status based on context it is used
func (*InterfaceStatus) MarshalBinary ¶
func (m *InterfaceStatus) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*InterfaceStatus) UnmarshalBinary ¶
func (m *InterfaceStatus) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LatestBackup ¶
type LatestBackup struct { // Latest backup ID. // Required: true ID *string `json:"id"` // Latest backup timestamp. // Example: 2018-11-14T15:20:32.004Z // Required: true // Format: date-time Timestamp *strfmt.DateTime `json:"timestamp"` }
LatestBackup Latest backup info.
swagger:model latestBackup
func (*LatestBackup) ContextValidate ¶
ContextValidate validates this latest backup based on context it is used
func (*LatestBackup) MarshalBinary ¶
func (m *LatestBackup) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LatestBackup) UnmarshalBinary ¶
func (m *LatestBackup) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ListOfCoordinates ¶ added in v0.2.0
type ListOfCoordinates []*CoordinatesXY
ListOfCoordinates list of coordinates
swagger:model ListOfCoordinates
func (ListOfCoordinates) ContextValidate ¶ added in v0.2.0
ContextValidate validate this list of coordinates based on the context it is used
type Semver ¶
type Semver struct { // current // Required: true Current *SemverVersion `json:"current"` // latest // Required: true Latest *SemverVersion `json:"latest"` }
Semver semver
swagger:model semver
func (*Semver) ContextValidate ¶
ContextValidate validate this semver based on the context it is used
func (*Semver) MarshalBinary ¶
MarshalBinary interface implementation
func (*Semver) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type SemverVersion ¶
type SemverVersion struct { // major // Example: 1 // Required: true Major *float64 `json:"major"` // minor // Example: 10 // Required: true Minor *float64 `json:"minor"` // order // Example: 65546.8.0 Order string `json:"order,omitempty"` // patch // Example: 8 // Required: true Patch *float64 `json:"patch"` }
SemverVersion semver version
swagger:model semverVersion
func (*SemverVersion) ContextValidate ¶
ContextValidate validates this semver version based on context it is used
func (*SemverVersion) MarshalBinary ¶
func (m *SemverVersion) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SemverVersion) UnmarshalBinary ¶
func (m *SemverVersion) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Site ¶
type Site struct { // Site ID. // Example: f7ac9cad-ea28-4390-93c8-7add010e8ee3 // Required: true ID *string `json:"id"` // Site name. // Example: Mount Everest Name string `json:"name,omitempty"` // parent Parent *Site `json:"parent,omitempty"` // Status of the site. // Example: active // Required: true // Enum: [active disconnected inactive] Status *string `json:"status"` // Type of the site. // Example: site // Required: true // Enum: [site endpoint] Type *string `json:"type"` }
Site site
swagger:model site
func (*Site) ContextValidate ¶
ContextValidate validate this site based on the context it is used
func (*Site) MarshalBinary ¶
MarshalBinary interface implementation
func (*Site) UnmarshalBinary ¶
UnmarshalBinary interface implementation
Source Files
¶
- coordinates_x_y.go
- device_firmware.go
- device_identification.go
- device_interface_schema.go
- device_meta.go
- device_overview.go
- device_statistics.go
- device_status_overview.go
- device_upgrade.go
- error.go
- interface_identification.go
- interface_statistics.go
- interface_status.go
- latest_backup.go
- list_of_coordinates.go
- semver.go
- semver_version.go
- site.go