summaryrefslogtreecommitdiffstats
path: root/API.txt
diff options
context:
space:
mode:
authorMartin Kosek <mkosek@redhat.com>2011-07-12 09:11:00 +0200
committerAdam Young <ayoung@redhat.com>2011-07-12 14:20:16 -0400
commite6c68e999358a323500aac9680c4aa8ca76a18cc (patch)
tree79109dc950a86090cbf827af51c75af5a78bd4f8 /API.txt
parent86230333a85489f64205dcda485aa7876fe4c906 (diff)
downloadfreeipa-e6c68e999358a323500aac9680c4aa8ca76a18cc.tar.gz
freeipa-e6c68e999358a323500aac9680c4aa8ca76a18cc.tar.xz
freeipa-e6c68e999358a323500aac9680c4aa8ca76a18cc.zip
Add DNS record modification command
The DNS record plugin does not support modification of a record. One can only add A type addresses to a DNS record or remove the current ones. To actually change a DNS record value it has to be removed and then added with a desired value. This patch adds a new DNS plugin command "dnsrecord-mod" which enables user to: - modify a DNS record value (note than DNS record can hold multiple values and those will be overwritten) - remove a DNS record when an empty value is passed New tests for this new command have been added to the CLI test suite. https://fedorahosted.org/freeipa/ticket/1137
Diffstat (limited to 'API.txt')
-rw-r--r--API.txt44
1 files changed, 44 insertions, 0 deletions
diff --git a/API.txt b/API.txt
index c1765394e..418599c41 100644
--- a/API.txt
+++ b/API.txt
@@ -681,6 +681,50 @@ output: Output('summary', (<type 'unicode'>, <type 'NoneType'>), 'User-friendly
output: ListOfEntries('result', (<type 'list'>, <type 'tuple'>), Gettext('A list of LDAP entries', domain='ipa', localedir=None))
output: Output('count', <type 'int'>, 'Number of entries returned')
output: Output('truncated', <type 'bool'>, 'True if not all results were returned')
+command: dnsrecord_mod
+args: 2,37,3
+arg: Str('dnszoneidnsname', cli_name='dnszone', label=Gettext('Zone name', domain='ipa', localedir=None), query=True, required=True)
+arg: Str('idnsname', attribute=True, cli_name='name', label=Gettext('Record name', domain='ipa', localedir=None), multivalue=False, primary_key=True, query=True, required=True)
+option: Flag('all', autofill=True, cli_name='all', default=False, exclude='webui', flags=['no_output'])
+option: Flag('raw', autofill=True, cli_name='raw', default=False, exclude='webui', flags=['no_output'])
+option: Str('version?', exclude='webui', flags=['no_option', 'no_output'])
+option: List('arecord?', _validate_ipaddr, attribute=True, cli_name='a_rec', label='A record', multivalue=True)
+option: List('aaaarecord?', _validate_ipaddr, attribute=True, cli_name='aaaa_rec', label='AAAA record', multivalue=True)
+option: List('a6record?', attribute=True, cli_name='a6_rec', label='A6 record', multivalue=True)
+option: List('afsdbrecord?', attribute=True, cli_name='afsdb_rec', label='AFSDB record', multivalue=True)
+option: List('aplrecord?', _validate_ipnet, attribute=True, cli_name='apl_rec', label='APL record', multivalue=True)
+option: List('certrecord?', attribute=True, cli_name='cert_rec', label='CERT record', multivalue=True)
+option: List('cnamerecord?', attribute=True, cli_name='cname_rec', label='CNAME record', multivalue=True)
+option: List('dhcidrecord?', attribute=True, cli_name='dhcid_rec', label='DHCID record', multivalue=True)
+option: List('dlvrecord?', attribute=True, cli_name='dlv_rec', label='DLV record', multivalue=True)
+option: List('dnamerecord?', attribute=True, cli_name='dname_rec', label='DNAME record', multivalue=True)
+option: List('dnskeyrecord?', attribute=True, cli_name='dnskey_rec', label='DNSKEY record', multivalue=True)
+option: List('dsrecord?', attribute=True, cli_name='ds_rec', label='DS record', multivalue=True)
+option: List('hiprecord?', attribute=True, cli_name='hip_rec', label='HIP record', multivalue=True)
+option: List('ipseckeyrecord?', attribute=True, cli_name='ipseckey_rec', label='IPSECKEY record', multivalue=True)
+option: List('keyrecord?', attribute=True, cli_name='key_rec', label='KEY record', multivalue=True)
+option: List('kxrecord?', attribute=True, cli_name='kx_rec', label='KX record', multivalue=True)
+option: List('locrecord?', attribute=True, cli_name='loc_rec', label='LOC record', multivalue=True)
+option: List('mxrecord?', _validate_mx, attribute=True, cli_name='mx_rec', label='MX record', multivalue=True)
+option: List('naptrrecord?', _validate_naptr, attribute=True, cli_name='naptr_rec', label='NAPTR record', multivalue=True)
+option: List('nsrecord?', attribute=True, cli_name='ns_rec', label='NS record', multivalue=True)
+option: List('nsecrecord?', attribute=True, cli_name='nsec_rec', label='NSEC record', multivalue=True)
+option: List('nsec3record?', attribute=True, cli_name='nsec3_rec', label='NSEC3 record', multivalue=True)
+option: List('nsec3paramrecord?', attribute=True, cli_name='nsec3param_rec', label='NSEC3PARAM record', multivalue=True)
+option: List('ptrrecord?', attribute=True, cli_name='ptr_rec', label='PTR record', multivalue=True)
+option: List('rrsigrecord?', attribute=True, cli_name='rrsig_rec', label='RRSIG record', multivalue=True)
+option: List('rprecord?', attribute=True, cli_name='rp_rec', label='RP record', multivalue=True)
+option: List('sigrecord?', attribute=True, cli_name='sig_rec', label='SIG record', multivalue=True)
+option: List('spfrecord?', attribute=True, cli_name='spf_rec', label='SPF record', multivalue=True)
+option: List('srvrecord?', _validate_srv, attribute=True, cli_name='srv_rec', label='SRV record', multivalue=True)
+option: List('sshfprecord?', attribute=True, cli_name='sshfp_rec', label='SSHFP record', multivalue=True)
+option: List('tarecord?', attribute=True, cli_name='ta_rec', label='TA record', multivalue=True)
+option: List('tkeyrecord?', attribute=True, cli_name='tkey_rec', label='TKEY record', multivalue=True)
+option: List('tsigrecord?', attribute=True, cli_name='tsig_rec', label='TSIG record', multivalue=True)
+option: List('txtrecord?', attribute=True, cli_name='txt_rec', label='TXT record', multivalue=True)
+output: Output('summary', (<type 'unicode'>, <type 'NoneType'>), 'User-friendly description of action performed')
+output: Entry('result', <type 'dict'>, Gettext('A dictionary representing an LDAP entry', domain='ipa', localedir=None))
+output: Output('value', <type 'unicode'>, "The primary_key value of the entry, e.g. 'jdoe' for a user")
command: dnsrecord_show
args: 2,4,3
arg: Str('dnszoneidnsname', cli_name='dnszone', label=Gettext('Zone name', domain='ipa', localedir=None), query=True, required=True)