diff options
author | Sergey Poznyakoff <gray@gnu.org.ua> | 2013-04-20 10:39:19 +0300 |
---|---|---|
committer | Sergey Poznyakoff <gray@gnu.org.ua> | 2013-04-20 10:39:19 +0300 |
commit | 67dce06bb26798e2b11ee0883bdc7e08d7edb663 (patch) | |
tree | 3f3655179dded2bbdd16c411d3f0558fe4515bf9 /doc/eclat-lsaddr.1 | |
parent | 347387193da605922ed98742dbc7fa3f67a908f4 (diff) | |
download | eclat-67dce06bb26798e2b11ee0883bdc7e08d7edb663.tar.gz eclat-67dce06bb26798e2b11ee0883bdc7e08d7edb663.tar.bz2 |
Major rewrite. Provide short names for each command.
Diffstat (limited to 'doc/eclat-lsaddr.1')
-rw-r--r-- | doc/eclat-lsaddr.1 | 101 |
1 files changed, 101 insertions, 0 deletions
diff --git a/doc/eclat-lsaddr.1 b/doc/eclat-lsaddr.1 new file mode 100644 index 0000000..8ae1565 --- /dev/null +++ b/doc/eclat-lsaddr.1 @@ -0,0 +1,101 @@ +.\" 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 LSADDR 1 "January 19, 2013" "ECLAT" "Eclat User Reference" +.SH NAME +eclat lsaddr \- return information about IP addresses in +your account +.SH SYNOPSIS +\fBeclat lsaddr\fR [\fB\-v\fR] [\fB\-\-vpc\fR] [\fBFILTER\fR...] + +\fBeclat lsaddr\fR \fB\-\-help\fR +.SH DESCRIPTION +This command returns information about Elastic IP addresses allocated +for your account. By default all allocated addresses are described. +This can be changed by specifying one or more filters. When filters +are supplied, only those addresses that match all of them are returned. +.SH OPTIONS +.TP +.BR \-v , \-\-vpc +Describe VPC addresses. By default, standard (EC2) addresses are +displayed. This option alters this behavior. +.SH FILTERS +.TP +\fBinstance\-id\fR=\fIstring\fR +The ID of the instance the address is associated with. +.TP +\fBpublic\-ip\fR=\fIstring\fR +Piblic IP address. +.TP +\fBallocation\-id\fR=\fIstring\fR +The allocation ID of the address (for VPC addresses only). +.TP +\fBassociation\-id\fR=\fIstring\fR +The association ID of the address (for VPC addresses only). +.TP +\fBnetwork\-interface\-id\fR=\fIstringf\fR +The network interface this IP is associated with (for VPC addresses only). +.TP +\fBnetwork\-interface\-owner\-id\fR=\fIstring\fR +The owner ID. +.TP +\fBprivate\-ip\-address\fR=\fIstring\fR +The private IP address associated with the Elastic IP (for VPC +addresses only). +.SH OUTPUT +The default output is organized in three to eight columns separated by +single \fBTAB\fR characters. The first three columns are common for +any address domain. The first column lists the interface type +(\fBstandard\fR of \fBvpc\fR). The second one shows the IP address. +The third column contains the ID of the instance this address is +associated with. For VPC addresses, additional five columns are +output: interface ID, interface owner ID, private IP address, +allocation ID and association ID. +.SH EXAMPLE +.sp +.nf +.in +2 +$ eclat lsaddr +standard 192.0.2.1 i-f15ebb98 +standard 198.51.100.2 +.in +.fi +.SH "SEE ALSO" +.BR eclat (1), +.BR eclat\-allocaddr (1), +.BR eclat\-freeaddr (1), +.BR eclat\-assocaddr (1), +.BR eclat\-disassaddr (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: + |