1
0
mirror of https://github.com/minio/docs.git synced 2025-07-30 07:03:26 +03:00
Files
docs/source/reference/minio-mc-admin/mc-admin-policy-list.rst
Ravind Kumar a6d554acdc DOCS-807, DOCS-846, Misc. Bug fixes (#861)
Closes #807 
Closes #846 


---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
2023-05-23 17:29:48 -04:00

84 lines
1.6 KiB
ReStructuredText

======================
``mc admin policy ls``
======================
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 2
.. mc:: mc admin policy ls
.. mc:: mc admin policy list
Syntax
------
.. start-mc-admin-policy-list-desc
Lists all policies on the target MinIO deployment.
.. end-mc-admin-policy-list-desc
The :mc:`mc admin policy list` command has equivalent functionality to :mc:`mc admin policy ls`.
.. tab-set::
.. tab-item:: EXAMPLE
The following command displays a list of the policies currently current on the :term:`alias` ``play``.
.. code-block:: shell
:class: copyable
mc admin policy ls play
.. tab-item:: SYNTAX
The command has the following syntax:
.. code-block:: shell
:class: copyable
mc admin policy ls TARGET
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-syntax
:end-before: end-minio-syntax
Parameters
~~~~~~~~~~
The :mc-cmd:`mc admin policy ls` command accepts the following arguments:
.. mc-cmd:: TARGET
The :mc-cmd:`alias <mc alias>` of a configured MinIO deployment from which the command lists the available policies.
Global Flags
~~~~~~~~~~~~
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-mc-globals
:end-before: end-minio-mc-globals
Examples
--------
List the policies that exist on the deployment at alias ``myminio``.
.. code-block:: shell
:class: copyable
mc admin policy ls myminio
Output
~~~~~~
The command returns output that resembles the following:
.. code-block:: shell
readwrite
writeonly