3ac2fc7322
git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@1516 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
160 lines
2.8 KiB
Plaintext
160 lines
2.8 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<-x>|B<--xml>] [B<-i> I<attr-list>]
|
|
[B<-w> I<attr>=I<val>,[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,[attr=val...]>
|
|
|
|
A comma-separated list of attributes and values that can be used to select items to display. Use the help option to get a list of valid attributes.
|
|
|
|
=item B<-x|--xml>
|
|
|
|
Display output in XML format.
|
|
|
|
=item B<-z|--stanza>
|
|
|
|
Display output in stanza format.
|
|
|
|
=back
|
|
|
|
|
|
=head1 RETURN VALUE
|
|
|
|
0 The command completed successfully.
|
|
|
|
1 An error has occurred.
|
|
|
|
|
|
=head1 EXAMPLES
|
|
|
|
=over 4
|
|
|
|
=item 1.
|
|
|
|
To get a list of all object names.
|
|
|
|
lsdef -a
|
|
|
|
=item 2.
|
|
|
|
To get a list of all the network definitions.
|
|
|
|
lsdef -t network
|
|
|
|
=item 3.
|
|
|
|
To get a complete listing of all network definitions.
|
|
|
|
lsdef -l -t network
|
|
|
|
=item 4.
|
|
|
|
To list the whole xCAT database and write it to a stanza file. (backup database)
|
|
|
|
lsdef -a -l -z > mydbstanzafile
|
|
|
|
=item 5.
|
|
|
|
To list the MAC and install adapter name for each node.
|
|
|
|
lsdef -t node -i mac,installnic
|
|
|
|
=item 6.
|
|
|
|
To list an osimage definition named "aix53J".
|
|
|
|
lsdef -t osimage -l -o aix53J
|
|
|
|
=item 7.
|
|
|
|
To list all adapter definitions for node "clstrn03".
|
|
|
|
lsdef -t adapter -w nodename=clstrn03
|
|
|
|
=item 8.
|
|
|
|
To list all the attributes of the group "service".
|
|
|
|
lsdef -l -t group -o service
|
|
|
|
=item 9.
|
|
|
|
To list all the attributes of the nodes that are members of the group "service".
|
|
|
|
lsdef -t node -l service
|
|
|
|
=item 10.
|
|
|
|
To list all nodes that have a service node called "FMS01".
|
|
|
|
lsdef -t node -w nfsserver=FMS01
|
|
|
|
=back
|
|
|
|
|
|
=head1 FILES
|
|
|
|
$XCATROOT/bin/lsdef
|
|
|
|
(The XCATROOT environment variable is set when xCAT is installed. The
|
|
default value is "/opt/xcat".)
|
|
|
|
|
|
=head1 NOTES
|
|
|
|
This command is part of the xCAT software product.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
See the mkdef(1), chdef(1), rmdef(1), and xcatstanzafile(5) commands. |