[MM-56000] Add LDAP job command to mmctl (#25633)

Этот коммит содержится в:
Ben Schumacher
2024-04-22 12:19:53 +02:00
коммит произвёл GitHub
родитель 8348acac49
Коммит 3dae305dc7
8 изменённых файлов: 476 добавлений и 7 удалений

Просмотреть файл

@@ -38,5 +38,6 @@ SEE ALSO
* `mmctl <mmctl.rst>`_ - Remote client for the Open Source, self-hosted Slack-alternative
* `mmctl ldap idmigrate <mmctl_ldap_idmigrate.rst>`_ - Migrate LDAP IdAttribute to new value
* `mmctl ldap job <mmctl_ldap_job.rst>`_ - List and show LDAP sync jobs
* `mmctl ldap sync <mmctl_ldap_sync.rst>`_ - Synchronize now

42
server/cmd/mmctl/docs/mmctl_ldap_job.rst Обычный файл
Просмотреть файл

@@ -0,0 +1,42 @@
.. _mmctl_ldap_job:
mmctl ldap job
--------------
List and show LDAP sync jobs
Synopsis
~~~~~~~~
List and show LDAP sync jobs
Options
~~~~~~~
::
-h, --help help for job
Options inherited from parent commands
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
::
--config string path to the configuration file (default "$XDG_CONFIG_HOME/mmctl/config")
--disable-pager disables paged output
--insecure-sha1-intermediate allows to use insecure TLS protocols, such as SHA-1
--insecure-tls-version allows to use TLS versions 1.0 and 1.1
--json the output format will be in json format
--local allows communicating with the server through a unix socket
--quiet prevent mmctl to generate output for the commands
--strict will only run commands if the mmctl version matches the server one
--suppress-warnings disables printing warning messages
SEE ALSO
~~~~~~~~
* `mmctl ldap <mmctl_ldap.rst>`_ - LDAP related utilities
* `mmctl ldap job list <mmctl_ldap_job_list.rst>`_ - List LDAP sync jobs
* `mmctl ldap job show <mmctl_ldap_job_show.rst>`_ - Show LDAP sync job

Просмотреть файл

@@ -0,0 +1,54 @@
.. _mmctl_ldap_job_list:
mmctl ldap job list
-------------------
List LDAP sync jobs
Synopsis
~~~~~~~~
List LDAP sync jobs
::
mmctl ldap job list [flags]
Examples
~~~~~~~~
::
ldap job list
Options
~~~~~~~
::
--all Fetch all import jobs. --page flag will be ignore if provided
-h, --help help for list
--page int Page number to fetch for the list of import jobs
--per-page int Number of import jobs to be fetched (default 200)
Options inherited from parent commands
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
::
--config string path to the configuration file (default "$XDG_CONFIG_HOME/mmctl/config")
--disable-pager disables paged output
--insecure-sha1-intermediate allows to use insecure TLS protocols, such as SHA-1
--insecure-tls-version allows to use TLS versions 1.0 and 1.1
--json the output format will be in json format
--local allows communicating with the server through a unix socket
--quiet prevent mmctl to generate output for the commands
--strict will only run commands if the mmctl version matches the server one
--suppress-warnings disables printing warning messages
SEE ALSO
~~~~~~~~
* `mmctl ldap job <mmctl_ldap_job.rst>`_ - List and show LDAP sync jobs

Просмотреть файл

@@ -0,0 +1,51 @@
.. _mmctl_ldap_job_show:
mmctl ldap job show
-------------------
Show LDAP sync job
Synopsis
~~~~~~~~
Show LDAP sync job
::
mmctl ldap job show [ldapJobID] [flags]
Examples
~~~~~~~~
::
import ldap show f3d68qkkm7n8xgsfxwuo498rah
Options
~~~~~~~
::
-h, --help help for show
Options inherited from parent commands
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
::
--config string path to the configuration file (default "$XDG_CONFIG_HOME/mmctl/config")
--disable-pager disables paged output
--insecure-sha1-intermediate allows to use insecure TLS protocols, such as SHA-1
--insecure-tls-version allows to use TLS versions 1.0 and 1.1
--json the output format will be in json format
--local allows communicating with the server through a unix socket
--quiet prevent mmctl to generate output for the commands
--strict will only run commands if the mmctl version matches the server one
--suppress-warnings disables printing warning messages
SEE ALSO
~~~~~~~~
* `mmctl ldap job <mmctl_ldap_job.rst>`_ - List and show LDAP sync jobs