Commands for Port 2000 Administration

Notes for Admin port:

New additions under 1.1b3
New additions under 1.1b4
New additions under 1.1R

***If you do not use the new config directory in 1.1b2+, changes are made online ONLY this means that it does NOT change acclist.txt or distributions.txt. So if you make a change with the admin port while NNTPRelay is running make sure that you change your config files accordingly

***If you are using the new config directory, acclist.txt and distributions.txt are not referenced after the first startup.

.**Captiliztion of Commands is important, be sure to captalize as below.

To authenticate on the admin port: (Userid and password are set in users.txt)

auth <userid> <password>

• GetSiteConfig <sitename> - List configuration and statistics for that site for outgoing feeds.
  • Ex: GetSiteConfig news.maxwell.syr.edu
• GetSiteList - List of all peering sites that receive feeds from that server.
• AddIncoming <sitename> - Add site to allow incoming peers.
  • Ex: AddIncoming news.maxwell.syr.edu
• ListIncoming - List of all peering sites that are allowed to feed that server.
• DelIncoming <sitename> - Remove a site from the allowed incoming list.
  • Ex: DelIncoming news.maxwell.syr.edu
• SetIncoming <sitename> <parameter> <value> - Change the configuration for an incoming access entry
  • streaming - determines the answer to the "mode stream" command 1=allowed, 0=not allowed
  • max_connections - sets the maximum number of connections allowed from this site
  • spamfilter - 1 = enabled for this site, 0 = disabled (b3 or later)
• GetIncomingConfig <sitename> - List configuration and statistics for that site for incoming feeds.
• CreateSite <sitename> <port> - Create a new outgoing feed, this should be followed by SetSite
  • Ex: CreateSite news.maxwell.syr.edu 119
• DeleteSite <sitename> - Remove outgoing feed.
• GetSiteStats - Returns a list of all outgoing sites and and their respective stats.
• SetSite <sitename> <command> <data>
  • distribution - setup distribution for outgoing feed.
    • Ex: SetSite news.maxwell.syr.edu distribution @*maxwell.syr.edu*,comp.*,rec.*,soc.*
  • createfeeder <feeder type> - create one feed connection
    • Ex: SetSite news.maxwell.syr.edu createfeeder L
  • deletefeeder <feeder number> - feeder number is referenced from GetSiteConfig.
    • Ex: SetSite news.maxwell.syr.edu deletefeeder
  • streaming <0 or 1> - Turns streaming to that site on and off. (By default it is on.)
    • Ex: SetSite news.maxwell.syr.edu streaming 0
• cancelbypass <0 or 1> - send cancels even if they don't match the distribution (poisons will exclude them, though)
• GetConfigString - returns the value of a configuration parameter from config.txt
• GetBaseStats - Returns stat totals for all incoming and outgoing feeds.
• GetWriteState - For debugging use, shows the current operation in the article write loop
• quit - Exit current admin session.
• help - Returns list of all commands.

New additions under 1.1b3

Note that the commands below are not currently persistent (ie, you need to add them in init.tcl if you want persistence). This will be fixed in a later version. (These apply to 1.1b3)

• SetMeDistrib <distribution> - sets the incoming filter disitribution
  • Ex: SetMeDistrib @*nasty.spammers.com*,~alt.binar*,!tw.*,*
    this will filter any posts with nasty.spammers.com in the path, will ignore any postings that are posted in any alt.binar* groups, will ignore any postings that are posted solely in tw.*, and accept everything else.
• SetMaxConnections <number> - Set the system-wide connection limit
  • Ex: SetMaxConnections 200
• GetIncomingState - shows the current number of users connected, and the current system-wide limit
• SetMaxForwardAge <age in seconds> - sets the maximum age of articles for forwarding
  • Ex: SetMaxForwardAge 86400
    limits articles forwarded to being one day old. Default is 7 days
• SpamFilter <0 or 1> - turns filtering off or on
• SpamLog <0 or 1> - turns spam logging off or on
• SetSpamTrigger <number> - how many posts do we give each host as an initial credit (default 25)
• SetSpamExpire <time in seconds> - how long do we remember spam levels (default 600 seconds)
• AddSpamExclusion <wildmatch> - exclude any posts where NNTP-Posting-Host matches the wildmatch
  • Ex: AddSpamExclusion *.news.aol.com*
• DelSpamExclusion <wildmatch> - remove an exclusion
• GetSpamExclusions - list all current exclusions

New additions under 1.1b4

• SetIncoming <sitename> <parameter> <value> - Change the configuration for an incoming access entry
  • allowssp <0 or 1> - allow incoming site to use the ssp command to retrieve stats.
    • Ex: SetIncoming stats.maxwell.syr.edu allowssp 1
  • matchdequeue <number of the site in GetSiteList> This keeps track through the precommit of articles offered to us by a site. If we get a precommit lock from site A and right after that receive a check/ihave from site B we note that site B has the article and we do not need to offer it to them.
    • Ex SetIncoming news.maxwell.syr.edu matchdequeue 23
  • trycompress <0 or 1> - Issue mode compress to remote server to initiate compressed streaming of articles.

New additions under 1.1R

• SetSite <site name> feedDelay <time in seconds> Will delay an outgoing feed for this number of seconds.
• SetSite <site name> bandwidth_limit <size in bytes> Will limit an outgoing feed to this bandwidth per second.
• SetSite <site name> ForceNoCheck <0 or 1> Will cause an outgoing feed to send takethis without checking to see if that host has the article already..