'\" t
.\"     Title: tgtd
.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 01/09/2023
.\"    Manual: [FIXME: manual]
.\"    Source: [FIXME: source]
.\"  Language: English
.\"
.TH "TGTD" "8" "01/09/2023" "[FIXME: source]" "[FIXME: manual]"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
tgtd \- The SCSI Target Daemon
.SH "SYNOPSIS"
.HP \w'\fBtgtd\fR\ 'u
\fBtgtd\fR
.HP \w'\fBtgtd\fR\ 'u
\fBtgtd\fR [\-C\ \-\-control\-port\ <INTEGER>] [\-d\ \-\-debug\ <INTEGER>] [\-f\ \-\-foregound] [\-h\ \-\-help] [\-\-iscsi\ <\&.\&.\&.>]
.SH "DESCRIPTION"
.PP
Tgtd is a SCSI Target daemon\&. It can be used to provide SCSI target service to a network\&. The most common service is iSCSI but other services are also supported\&.
.SH "DEVICE TYPES"
.PP
Tgtd provides support for both emulated and passthrough of real devices\&.
.sp
.if n \{\
.RS 4
.\}
.nf
    Tgtd can emulate the following types of devices:
    
    disk       : Normal disk device\&. Emulates a SCSI harddisk\&.
    tape       : Tape device\&. Emulates a SCSI tape drive\&.
    cd         : CD device\&. Emulates a SCSI DVD burner\&.
    changer    : Media changer\&. Emulate the changer device for a virtual tape library or DVD jukebox\&.
  
.fi
.if n \{\
.RE
.\}
.SH "OPTIONS"
.PP
\-d \-\-debug <INTEGER>
.RS 4
Set to non\-zero value to activate additional debugging messages to be logged\&.
.RE
.PP
\-f \-\-foreground
.RS 4
Run the daemon in the foreground\&.
.RE
.PP
\-h \-\-help
.RS 4
Print help text to the screen\&.
.RE
.PP
\-C \-\-control\-port <INTEGER>
.RS 4
This comamnd is used to specify the control port to use for this instance of tgtd\&. This allows to run multiple instances of TGTD on a host\&.
.sp
TGTADM has a matching argument to control which instance to connect to\&.
.RE
.PP
\-\-iscsi <\&.\&.\&.>
.RS 4
ISCSI specific options\&. See the ISCSI section below for options specific to this frontend\&.
.RE
.SH "ISCSI OPTIONS"
.PP
These parameters apply only to the iSCSI frontend\&.
.SS "portal=<ip\-address[:port]>"
.PP
This option is used to bind tgtd to a specific ip\-address/portal and/or port\&. By default tgtd will bind to port 3260 on the wildcard address\&. The ip\-address part (before the ":") can be missing to designate the wildcard address with a none\-default port\&.
.PP
Example: to bind tgtd to a specific address and port
.sp
.if n \{\
.RS 4
.\}
.nf
	tgtd \-\-iscsi portal=192\&.0\&.2\&.1:3260
      
.fi
.if n \{\
.RE
.\}
.sp
Example: to bind tgtd to any address but a none\-default port
.sp
.if n \{\
.RS 4
.\}
.nf
	tgtd \-\-iscsi portal=:3251
      
.fi
.if n \{\
.RE
.\}
.sp
.SS "nop_interval=<integer>"
.PP
This sets the default interval for sending NOP\-OUT to probe for connected initiators\&. This parameter only controls the default value for targets\&. Individual targets can be controlled using tgtadm\&.
.PP
The default value is 0 which means that the feature is disabled TGTD will not send any NOP\-OUT probes\&.
.SS "nop_count=<integer>"
.PP
This sets the default value for after how many failed probes TGTD will consider the initiator dead and tear down the session\&. This parameter only controls the default value for targets\&. Individual targets can be controlled using tgtadm\&.
.PP
The default value is 0\&.
.PP
Example: send NOP\-OUT every 5 seconds and abort the session after 6 failures\&.
.sp
.if n \{\
.RS 4
.\}
.nf
	tgtd \-\-iscsi portal=192\&.0\&.2\&.1:3260,nop_interval=5,nop_count=6
      
.fi
.if n \{\
.RE
.\}
.sp
.SH "ENVIRONMENT VARIABLES"
.SS "TGT_IPC_SOCKET=<path>"
.PP
When set tgtd and tgtadm will use the specified path as the IPC socket instead of the default \*(Aq/var/run/tgtd/socket\&.0\*(Aq
.SH "SEE ALSO"
.PP
targets\&.conf(5), tgtadm(8), tgt\-admin(8), tgtimg(8), tgt\-setup\-lun(8)\&.
\m[blue]\fB\%https://github.com/fujita/tgt\fR\m[]
.SH "COPYRIGHT/LICENSE"
.sp
.if n \{\
.RS 4
.\}
.nf
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or (at
your option) any later version\&.

This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE\&.  See the GNU
General Public License for more details\&.

You should have received a copy of the GNU General Public License
along with this program; if not, see http://www\&.gnu\&.org/licenses/\&.
.fi
.if n \{\
.RE
.\}