.. Open Infrastructure: compute-tools

.. Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net>
..
.. SPDX-License-Identifier: GPL-3.0+
..
.. 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 3 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 <https://www.gnu.org/licenses/>.

==============
container-list
==============

----------------------------
List container on the system
----------------------------

:manual section: 1
:manual group: Open Infrastructure

Synopsis
========

| **container list** ['OPTIONS']
| **cnt ls** ['OPTIONS']

Description
===========

The **container list** command lists container on the system.

Options
=======

The following **container list** options are available, defaults to '--started
--stopped':

-a, --all:
  List all available container (started, stopped, and other).

--csv-separator='SEPARATOR':
  Specify custom CSV separator, defaults to ','.

-f, --format='FORMAT':
  Use format to list container. Currently available formats are 'cli' (default),
  'csv', 'json', 'nwdiag', 'shell', 'sh', 'yaml', or 'xml'.

-h, --host='HOSTNAME':
  List only container that are enabled for automatic start on the specified
  hostname. Defaults to list containers of the local system only. Using 'all'
  shows all container regardless of any automatic start configuration.

--nwdiag-color='COLOR':
  Specify custom nwdiag color for the host box, defaults to '#3465a4'.

--nwdiag-label='LABEL':
  Specify custom nwdiag label for the diagram, defaults to empty.

-o, --other:
  List only container that are not enable for automatic start on the current
  system.

-s, --started:
  List only started container.

-t, --stopped:
  List only stopped container.

Examples
========

List all started and stopped containers of the local system:

  sudo container list

List all started and other containers:

  sudo container list -s -o

Create a CSV export of all started and stopped containers:

  sudo container list -f csv

Create a JSON export of all started and stopped containers:

  sudo container list -f json

Create a nwdiag export of all started and stopped containers:

  sudo container list -f nwdiag

Create a SVG image via nwdiag of all started and stopped containers:

  sudo container list -f nwdiag | nwdiag -T svg -o cnt-list.svg -

Create a shell export of all started and stopped containers:

  sudo container list -f shell
  sudo container list -f sh

Create a YAML export of all started and stopped containers:

  sudo container list -f yaml

Create a XML export of all started and stopped containers:

  sudo container list -f xml

See also
========

| compute-tools(7),
| container(1).

Homepage
========

More information about compute-tools and the Open Infrastructure project can be
found on the homepage (https://open-infrastructure.net).

Contact
=======

Bug reports, feature requests, help, patches, support and everything else are
welcome on the Open Infrastructure Software Mailing List
<software@lists.open-infrastructure.net>.

Debian specific bugs can also be reported in the Debian Bug Tracking System
(https://bugs.debian.org).

Authors
=======

compute-tools were written by Daniel Baumann
<daniel.baumann@open-infrastructure.net> and others.
