summaryrefslogtreecommitdiffstats
path: root/API.txt
diff options
context:
space:
mode:
authorMartin Babinsky <mbabinsk@redhat.com>2016-05-30 18:18:38 +0200
committerMartin Basti <mbasti@redhat.com>2016-06-13 17:50:54 +0200
commit80cbddaa37241e5c762edb656e4c658e652c87ef (patch)
tree082f2b1badf910ec7263bb12a2580f0e159aa9f3 /API.txt
parent40d8dded7fc1e71621516da9197c736057c0b6e4 (diff)
downloadfreeipa-80cbddaa37241e5c762edb656e4c658e652c87ef.tar.gz
freeipa-80cbddaa37241e5c762edb656e4c658e652c87ef.tar.xz
freeipa-80cbddaa37241e5c762edb656e4c658e652c87ef.zip
Server Roles: public API for server roles
This patch implements the `serverroles` API plugin which introduces the following commands: * server-role-show SERVER ROLE: show status of a single role on a server * server-role-find [--server SERVER [--role SERVROLE [--status=STATUS]]]: find role(s) SERVROLE and return their status on IPA masters. If --server option is given, the query is limited to this server. --status options filters the output by status [enabled vs. configurer vs. absent] https://fedorahosted.org/freeipa/ticket/5181 http://www.freeipa.org/page/V4/Server_Roles Reviewed-By: Jan Cholasta <jcholast@redhat.com> Reviewed-By: Martin Basti <mbasti@redhat.com> Reviewed-By: Pavel Vomacka <pvomacka@redhat.com>
Diffstat (limited to 'API.txt')
-rw-r--r--API.txt25
1 files changed, 25 insertions, 0 deletions
diff --git a/API.txt b/API.txt
index 4247dd77c..f52f23f13 100644
--- a/API.txt
+++ b/API.txt
@@ -4043,6 +4043,31 @@ option: Str('version?')
output: Entry('result')
output: Output('summary', type=[<type 'unicode'>, <type 'NoneType'>])
output: PrimaryKey('value')
+command: server_role_find
+args: 1,8,4
+arg: Str('criteria?')
+option: Flag('all', autofill=True, cli_name='all', default=False)
+option: Flag('raw', autofill=True, cli_name='raw', default=False)
+option: Str('role_servrole?', autofill=False, cli_name='role')
+option: Str('server_server?', autofill=False, cli_name='server')
+option: Int('sizelimit?', autofill=False)
+option: StrEnum('status?', autofill=False, cli_name='status', default=u'enabled', values=[u'enabled', u'configured', u'absent'])
+option: Int('timelimit?', autofill=False)
+option: Str('version?')
+output: Output('count', type=[<type 'int'>])
+output: ListOfEntries('result')
+output: Output('summary', type=[<type 'unicode'>, <type 'NoneType'>])
+output: Output('truncated', type=[<type 'bool'>])
+command: server_role_show
+args: 2,3,3
+arg: Str('server_server', cli_name='server')
+arg: Str('role_servrole', cli_name='role')
+option: Flag('all', autofill=True, cli_name='all', default=False)
+option: Flag('raw', autofill=True, cli_name='raw', default=False)
+option: Str('version?')
+output: Entry('result')
+output: Output('summary', type=[<type 'unicode'>, <type 'NoneType'>])
+output: PrimaryKey('value')
command: server_show
args: 1,5,3
arg: Str('cn', cli_name='name')