4997d886f1
git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@3806 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
169 lines
3.6 KiB
Plaintext
169 lines
3.6 KiB
Plaintext
=head1 NAME
|
|
|
|
B<lsdef> - Use this command to list xCAT data object definitions.
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
B<lsdef> [B<-h>|B<--help>] [B<-t> I<object-types>]
|
|
|
|
B<lsdef> [B<-V>|B<--verbose>] [B<-l>|B<--long>] [B<-a>|B<--all>] [B<-t> I<object-types>]
|
|
[B<-o> I<object-names>] [B<-z>|B<--stanza>] [B<-i> I<attr-list>]
|
|
[[B<-w> I<attr>==I<val>] [B<-w> I<attr>=~I<val>] ...] [I<noderange>]
|
|
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
This command is used to display xCAT object definitions which are stored
|
|
in the xCAT database.
|
|
|
|
|
|
=head1 OPTIONS
|
|
|
|
=over 10
|
|
|
|
=item B<-a|--all>
|
|
|
|
Display all definitions.
|
|
|
|
=item B<-h|--help>
|
|
|
|
Display usage message.
|
|
|
|
=item B<-i> I<attr-list>
|
|
|
|
Comma separated list of attribute names to display.
|
|
|
|
=item B<-l|--long>
|
|
|
|
List the complete object definition. (The default for some options is to give only a list of object names.)
|
|
|
|
=item I<noderange>
|
|
|
|
A set of comma delimited node names and/or group names.
|
|
See the "noderange" man page for details on supported formats.
|
|
|
|
=item B<-o> I<object-names>
|
|
|
|
A set of comma delimited object names.
|
|
|
|
=item B<-t> I<object-types>
|
|
|
|
A set of comma delimited object types. Use the help option to get a list of valid objects.
|
|
|
|
=item B<-V|--verbose>
|
|
|
|
Verbose mode.
|
|
|
|
=item B<-w> I<attr==val> B<-w> I<attr=~val> ...
|
|
|
|
Use one or multiple -w flags to specify the selection string that can be used to select objects. The operators ==, !=, =~ and !~ are available. Use the help option to get a list of valid attributes for each object type.
|
|
|
|
Operator descriptions:
|
|
== Select nodes where the attribute value is exactly this value.
|
|
!= Select nodes where the attribute value is not this specific value.
|
|
=~ Select nodes where the attribute value matches this regular expression.
|
|
!~ Select nodes where the attribute value does not match this regular expression.
|
|
|
|
Note: if the "val" fields includes spaces or any other characters that will be parsed by shell, the "attr<operator>val" needs to be quoted. If the operator is "!~", the "attr<operator>val" needs to be quoted using single quote.
|
|
|
|
=item B<-z|--stanza>
|
|
|
|
Display output in stanza format. See the xcatstanzafile man page for details on using xCAT stanza files.
|
|
|
|
=back
|
|
|
|
|
|
=head1 RETURN VALUE
|
|
|
|
0 The command completed successfully.
|
|
|
|
1 An error has occurred.
|
|
|
|
|
|
=head1 EXAMPLES
|
|
|
|
=over 4
|
|
|
|
=item 1.
|
|
|
|
To display a description of all the valid attributes that could be used
|
|
when defining an xCAT node.
|
|
|
|
lsdef -t node -h
|
|
|
|
=item 2.
|
|
|
|
To get a list of all the objects that have been defined.
|
|
|
|
lsdef -a
|
|
|
|
=item 3.
|
|
|
|
To get a list of all the network definitions.
|
|
|
|
lsdef -t network
|
|
|
|
=item 4.
|
|
|
|
To get a complete listing of all network definitions.
|
|
|
|
lsdef -l -t network
|
|
|
|
=item 5.
|
|
|
|
To list the whole xCAT database and write it to a stanza file. (backup database)
|
|
|
|
lsdef -a -l -z > mydbstanzafile
|
|
|
|
=item 6.
|
|
|
|
To list the MAC and install adapter name for each node.
|
|
|
|
lsdef -t node -i mac,installnic
|
|
|
|
=item 7.
|
|
|
|
To list an osimage definition named "aix53J".
|
|
|
|
lsdef -t osimage -l -o aix53J
|
|
|
|
=item 8.
|
|
|
|
To list all node definitions that have a status value of "booting".
|
|
|
|
lsdef -t node -w status==booting
|
|
|
|
=item 9.
|
|
|
|
To list all the attributes of the group "service".
|
|
|
|
lsdef -l -t group -o service
|
|
|
|
=item 10.
|
|
|
|
To list all the attributes of the nodes that are members of the group "service".
|
|
|
|
lsdef -t node -l service
|
|
|
|
=item 11.
|
|
|
|
To get a listing of object definitions that includes information about
|
|
what xCAT database tables are used to store the data.
|
|
|
|
lsdef -V -l -t node -o node01
|
|
|
|
=back
|
|
|
|
|
|
=head1 FILES
|
|
|
|
/opt/xcat/bin/lsdef
|
|
|
|
=head1 NOTES
|
|
|
|
This command is part of the xCAT software product.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<mkdef(1)|mkdef.1>, L<chdef(1)|chdef.1>, L<rmdef(1)|rmdef.1>, L<xcatstanzafile(5)|xcatstanzafile.5>
|