Files
bitburner-src/markdown/bitburner.server.md
Michael Taylor dcd2f33f7c CODEBASE: Update api-documentor and api-extractor (#2320)
* Update api-documentor and api-extractor. #1566 follow-up.

I have verified that the HTML/markdown table generation bug in
[#4878](https://github.com/microsoft/rushstack/issues/4878) in rushstack
for api-documentor has been fixed as per rushstack#5256. The testcase
[repro](https://github.com/catloversg/api-documenter-bug-pr-4578) now
produces the correct expected output.

I have confirmed that the generated output in bitburner from
`npm run doc` now generated HTML tables, and correctly inserts
a blank line between the </table> and the follow line (e.g. Returns).

Stylisticly it could use some whitespace, but it is correctly rendered.

This commit is only the updated packages, not the updated generated
documentation. I assume that is automatically generated by the GitHub
workflow.

* Follow up to 5f732a6f35, include `npm run doc` changed docs.

* Add missing license info

* Fix React warning

---------

Co-authored-by: CatLover <152669316+catloversg@users.noreply.github.com>
2025-09-26 14:52:39 -07:00

4.7 KiB

Home > bitburner > Server

Server interface

A server. Not all servers have all of these properties - optional properties are missing on certain servers.

Signature:

export interface Server 

Properties

Property

Modifiers

Type

Description

backdoorInstalled?

boolean

(Optional) Flag indicating whether this server has a backdoor installed by a player

baseDifficulty?

number

(Optional) Server's initial server security level at creation.

cpuCores

number

How many CPU cores this server has. Affects magnitude of grow and weaken ran from this server.

ftpPortOpen

boolean

Whether or not the FTP port is open

hackDifficulty?

number

(Optional) Server Security Level

hasAdminRights

boolean

Flag indicating whether player has admin/root access to this server

hostname

string

Hostname. Must be unique

httpPortOpen

boolean

Whether or not the HTTP Port is open

ip

string

IP Address. Must be unique

isConnectedTo

boolean

Flag indicating whether player is currently connected to this server

maxRam

number

RAM (GB) available on this server

minDifficulty?

number

(Optional) Minimum server security level that this server can be weakened to

moneyAvailable?

number

(Optional) How much money currently resides on the server and can be hacked

moneyMax?

number

(Optional) Maximum amount of money that this server can hold

numOpenPortsRequired?

number

(Optional) Number of open ports required in order to gain admin/root access

openPortCount?

number

(Optional) How many ports are currently opened on the server

organizationName

string

Name of company/faction/etc. that this server belongs to, not applicable to all Servers

purchasedByPlayer

boolean

Flag indicating whether this is a purchased server

ramUsed

number

RAM (GB) used. i.e. unavailable RAM

requiredHackingSkill?

number

(Optional) Hacking level required to hack this server

serverGrowth?

number

(Optional) Growth effectiveness statistic. Higher values produce more growth with ns.grow()

smtpPortOpen

boolean

Whether or not the SMTP Port is open

sqlPortOpen

boolean

Whether or not the SQL Port is open

sshPortOpen

boolean

Whether or not the SSH Port is open