User Domain Commands

This page includes the following:

add_user_domain()

Add a new user domain to the database with the given name and properties.

Parameters:

  • name - the name of the user domain that is being added, as returned by user_domains(), see User Domain Commands

  • properties - XML string containing all the information about LDAP servers, etc.

  • domain_type (optional) - one of 'ldap', 'eiam', or 'kerberos'

    Default: 'ldap'

  • default_login (optional) - whether or not the user domain is the default login domain

    Default: False

  • hide_login (optional) - whether or not to hide the user domain from login

    Default: False

Dependencies:

  • Must be logged in as admin

Result:

  • New use domain created with specified name and properties

Example add_user_domain() command line usage: 

>>> add_user_domain(name='test_domain', properties=
     '<?xml version="1.0" encoding="UTF-8"?>\n<domain-properties>\n
     <host>qa003</host>\n <port>5250</port>\n <user>admin</user>\n
     <password>password</password>\n <jawsapp>QATest</jawsapp>\n
     <autosysapp/>\n</domain-properties>', domain_type='eiam')
add domain "test_domain":
done

Example add_user_domain() script usage: 

import sys
from jaws import *

login()
print 'begin'
try:
     add_user_domain(name='test_domain', properties=
     '<?xml version="1.0" encoding="UTF-8"?>\n'
     + '<domain-properties>\n'
        + '<host>qa003</host>\n'
        + '<port>5250</port>\n'
        + '<user>admin</user>\n'
        + '<password>password</password>\n'
        + '<jawsapp>QATest</jawsapp>\n'
        + '<autosysapp/>\n'
     + '</domain-properties>',
     domain_type='eiam')

     print 'end'

finally:
      logout()

delete_user_domain()

Delete the named user domain, along with associated users.

Parameters:

Dependencies:

  • Must be logged in as admin

Result:

  • Given user domain and associated users deleted

Example delete_user_domain() command line usage: 

>>> delete_user_domain(name='ldapdomain')
delete user domain: ldapdomain
done

>>> delete_user_domain('ldapdomain')

Example delete_user_domain() script usage: 

import sys
from jaws import *

login()
print 'begin'
try:
     doms = user_domains()
     for d in doms:
        delete_user_domain(d)

     print 'end'

finally:
     logout()

update_user_domain()

Rename and/or change properties for the named user domain.

Note: This method cannot be used to change the _type_ of the domain.

Parameters:

  • name - name of the user domain, as returned by user_domains(), see User Domain Commands

  • new_name (optional) - if not None, the name of the domain is changed to this value

    Default: None

  • new_properties (optional) - if not None, the properties of the domain are replaced by this XML string

    Default: None

  • new_default_login (optional) - if not None, set the user domain to the default login domain

    Default: None

  • new_hide_login (optional) - if not None, set the user domain to be hidden from login

    Default: None

Dependencies:

  • Must be logged in as admin

Result:

  • Specified properties updated for given user domain

Example update_user_domain() command line usage: 

>>> update_user_domain(name='test_domain', new_name='update_domain',
     new_properties='<?xml version="1.0" encoding="UTF-8"?>\n
     <domain-properties>\n <host>qa002</host>\n
     <port>5252</port>\n <user>admin335</user>\n
     <password>password2</password>\n <jawsapp>QATest</jawsapp>\n
     <autosysapp/>\n</domain-properties>')
update domain: "test_domain"
   rename to "update_domain"
   new properties
done

Example update_user_domain() script usage: 

import sys
from jaws import *

login()
print 'begin'
try:
     update_user_domain(name='update_domain', new_name='test_domain')

     print 'end'

finally:
     logout()

user_domain_properties()

Get the configuration of the named user domain as an XML-formatted string.

Parameters:

Dependencies:

  • Must be logged in as admin

Result:

  • An XML-formatted string representing the properties of the given user domain

Example user_domain_properties() command line usage: 

>>> user_domain_properties(name='QAtest')
u'<?xml version="1.0" encoding="UTF-8"?>\n<domain-properties>\n
     <host>qa003</host>\n <port>5250</port>\n
     <user>EiamAdmin</user>\n <password>st1rl1ng</password>\n
     <jawsapp>QATest</jawsapp>\n <autosysapp/>\n
     </domain-properties>'

>>> user_domain_properties('QAtest')

Example user_domain_properties() script usage: 

import sys
from jaws import *

login()
print 'begin output'
try:
     doms = user_domains()
     for d in doms:
        print d + ": " + user_domain_properties(d)

     print 'end output'

finally:
     logout()

user_domains()

Get a list of names of external user domains.

This includes domains that are not enabled for password login. For more information, see login_domains(), see login_domains().

Parameters:

  • None

Dependencies:

  • Must be logged in as admin

Result:

  • A list of user domains

Example user_domains() command line usage: 

>>> user_domains() 
[u'ldapdomain', u'QAtest']

Example user_domains() script usage: 

import sys
from jaws import *

login()
print 'begin output'
try:
     doms = user_domains()
     for d in doms:
        print d

     print 'end output'

finally:
     logout()