@shadmanZero/tenantos-api
    Preparing search index...

    Interface Server

    Server resource interface

    Represents a physical or virtual server managed by TenantOS. This is one of the core resources in the system and contains comprehensive information about server configuration, hardware, and operational status.

    const server: Server = {
      id: 123,
      hostname: 'web-server-01',
      servername: 'Web Server 01',
      user_id: 1,
      os: 'Ubuntu 22.04',
      servertype: 'dedicated',
      primaryip: '192.168.1.100',
      owner_realname: 'John Doe',
      tags: ['web', 'production'],
      description: 'Main web server for production environment'
    };
    interface Server {
        consoleprovider?: { type: string };
        description: string;
        detailedHardwareInformation?: DetailedHardwareInformation;
        diskwipeRunning?: number;
        hardwarecollectRunning?: number;
        hostname: string;
        id: number;
        ipassignments?: readonly ServerIPAssignment[];
        os: string;
        owner_realname: string;
        passwordResetRunning?: number;
        powerprovider?: { supportedFeatures: readonly string[]; type: string };
        primaryip: string;
        reinstallationRunning?: number;
        rescueBootRunning?: number;
        result?: unknown;
        servername: string;
        servertype: string;
        tags: readonly string[];
        user_id: number;
    }
    Index

    Properties

    consoleprovider? description detailedHardwareInformation? diskwipeRunning? hardwarecollectRunning? hostname id ipassignments? os owner_realname passwordResetRunning? powerprovider? primaryip reinstallationRunning? rescueBootRunning? result? servername servertype tags user_id

    Properties

    consoleprovider?: { type: string }

    Console access provider configuration

    Type Declaration

    • Readonlytype: string

      Type of console provider

    description: string

    Server description or notes

    detailedHardwareInformation?: DetailedHardwareInformation

    Detailed hardware information (if available)

    diskwipeRunning?: number

    Flag indicating if disk wipe operation is currently running

    hardwarecollectRunning?: number

    Flag indicating if hardware collection is currently running

    hostname: string

    Server hostname (FQDN)

    id: number

    Unique identifier for the server

    ipassignments?: readonly ServerIPAssignment[]

    IP assignments for this server

    os: string

    Operating system installed on the server

    owner_realname: string

    Real name of the server owner

    passwordResetRunning?: number

    Flag indicating if password reset operation is currently running

    powerprovider?: { supportedFeatures: readonly string[]; type: string }

    Power management provider configuration

    Type Declaration

    • ReadonlysupportedFeatures: readonly string[]

      List of supported power management features

    • Readonlytype: string

      Type of power provider (e.g., 'ipmi', 'redfish')

    primaryip: string

    Primary IP address of the server

    reinstallationRunning?: number

    Flag indicating if OS reinstallation is currently running (1 = yes, 0 = no)

    rescueBootRunning?: number

    Flag indicating if rescue boot is currently active

    result?: unknown

    Operation result data

    servername: string

    Human-readable server name

    servertype: string

    Type of server (e.g., 'dedicated', 'virtual', 'cloud')

    tags: readonly string[]

    Array of tags for categorization and filtering

    user_id: number

    ID of the user who owns this server

    Settings

    Member Visibility

    On This Page

    Properties