aboutsummaryrefslogtreecommitdiff
path: root/doc/eclat-lssg.1
diff options
context:
space:
mode:
authorSergey Poznyakoff <gray@gnu.org.ua>2013-04-20 10:39:19 +0300
committerSergey Poznyakoff <gray@gnu.org.ua>2013-04-20 10:39:19 +0300
commit67dce06bb26798e2b11ee0883bdc7e08d7edb663 (patch)
tree3f3655179dded2bbdd16c411d3f0558fe4515bf9 /doc/eclat-lssg.1
parent347387193da605922ed98742dbc7fa3f67a908f4 (diff)
downloadeclat-67dce06bb26798e2b11ee0883bdc7e08d7edb663.tar.gz
eclat-67dce06bb26798e2b11ee0883bdc7e08d7edb663.tar.bz2
Major rewrite. Provide short names for each command.
Diffstat (limited to 'doc/eclat-lssg.1')
-rw-r--r--doc/eclat-lssg.1134
1 files changed, 134 insertions, 0 deletions
diff --git a/doc/eclat-lssg.1 b/doc/eclat-lssg.1
new file mode 100644
index 0000000..86ab244
--- /dev/null
+++ b/doc/eclat-lssg.1
@@ -0,0 +1,134 @@
+.\" This file is part of Eclat -*- nroff -*-
+.\" Copyright (C) 2012, 2013 Sergey Poznyakoff
+.\"
+.\" Eclat 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 3, or (at your option)
+.\" any later version.
+.\"
+.\" Eclat 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 Eclat. If not, see <http://www.gnu.org/licenses/>.
+.TH LSSEC 1 "January 19, 2013" "ECLAT" "Eclat User Reference"
+.SH NAME
+eclat lssg \- return information about security groups
+.SH SYNOPSIS
+\fBeclat lssg\fR [\fB\-n\fR] [\fB\-\-name\fR]\
+ [\fBFILTER\fR...] [\fBID\fR]
+
+\fBeclat lssg\fR \fB\-\-help\fR
+.SH DESCRIPTION
+This command returns information about security groups. By default,
+all security groups pertaining to your account will be described.
+Particular groups can be selected by specifying their IDs (or names,
+if the \fB\-n\fR (\fB\-\-name\fR) option is used) in the command
+line. The set of groups can further be abridged by using filters.
+.PP
+If ID mapping is enabled (see the section \fBMAPS\fR
+in
+.BR eclat (1)),
+this command translates \fBID\fR supplied in the command line
+using the \fBGroupId\fR map or \fBGroupName\fR map, if the \fB\-n\fR
+(\fB\-\-name\fR) option is used.
+.SH OPTIONS
+.TP
+\fB\-n\fR, \fB\-\-name\fR
+Treat group identifiers supplied in the command line as group names.
+By default they are treated as group IDs.
+.SH FILTERS
+.TP
+\fBdescription\fR=\fIstring\fR
+The description of the security group.
+.TP
+\fBgroup\-id\fR=\fIstring\fR
+The ID of the security group.
+.TP
+\fBgroup\-name\fR=\fIstring\fR
+The name of the security group.
+.TP
+\fBip\-permission.cidr\fR=\fBstring\fR
+The CIDR range that has been granted the permission. See the note below.
+.TP
+\fBip\-permission.from\-port\fR=\fIstring\fR
+For the TCP and UDP, the start of port range, for ICMP -- the ICMP type
+number.
+.TP
+\fBip\-permission.group\-name\fR=\fIstring\fR
+The name of security group that has been granted the permission.
+.TP
+\fBip\-permission.protocol\fR=\fIvalue\fB
+The IP protocol for the permission. One of:
+.BR tcp ,
+.BR udp ,
+.BR icmp ,
+or a protocol number.
+.TP
+\fBip\-permission.to\-port\fR=\fIstring\fR
+The end of port range for the TCP and UDP protocols, or an ICMP code.
+.TP
+\fBip\-permission.user\-id\fR=\fIstring\fR
+The ID of an AWS account that has been granted the permission.
+.TP
+\fBowner\-id\fR=\fIstring\fR
+The AWS account ID of the owner of the security group.
+.TP
+\fBtag\-key\fR=\fIstring\fR
+The key of a tag assigned to the security group.
+.TP
+\fBtag\-value\fR=\fIstring\fR
+The value of a tag assigned to the security group.
+.PP
+Notice, that all filters use literal matching only. This means that
+you cannot use, e.g., \fBip\-permission.cidr\fR to check for a
+particular IP address. Instead, the argument to
+\fBip\-permission.cidr\fR must be the CIDR exactly as stored in the
+group description. The same holds true for other filters as well.
+.SH OUTPUT
+The output is multi-line. Each group begins with a \fBGroup\fR line,
+containing the group ID, name and description. Following lines
+describe the VPC ID and tags (if any). Tags are listed in as
+\fBkey\fB=\fBvalue\fR pairs, each on a separate line and indented by
+one tabstop. The lines that follow list the rules for incoming and
+outgoing traffic. E.g.:
+.sp
+.nf
+.in +2
+Group sg\-443d0a12 WebServers "Web Servers"
+VPC ID:
+Incoming:
+tcp 0.0.0.0/0 80
+Outgoing:
+Group sg\-5ff8a023 RangedPortsBySource "Group A"
+VPC ID:
+Incoming:
+user 111122223333, group sg\-99gh4012 ("Group B") 6000\-7000
+Outgoing:
+.in
+.fi
+.SH "SEE ALSO"
+.BR eclat (1).
+.SH AUTHORS
+Sergey Poznyakoff
+.SH "BUG REPORTS"
+Report bugs to <bug\-eclat@gnu.org.ua>.
+.SH COPYRIGHT
+Copyright \(co 2012, 2013 Sergey Poznyakoff
+.br
+.na
+License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
+.br
+.ad
+This is free software: you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law.
+.\" Local variables:
+.\" eval: (add-hook 'write-file-hooks 'time-stamp)
+.\" time-stamp-start: ".TH [A-Z_][A-Z0-9_.\\-]* [0-9] \""
+.\" time-stamp-format: "%:B %:d, %:y"
+.\" time-stamp-end: "\""
+.\" time-stamp-line-limit: 20
+.\" end:
+

Return to:

Send suggestions and report system problems to the System administrator.