Property Commands

add_property()

Add a new AAI property with the specified name and value.

Parameters:

• property_name - the name of the AAI property to be added
• value - the value of the specified AAI property

Dependencies:

• Must be logged in as admin
• Throws constraint violation exception if given property already exists

Result:

• New AAI property added with given values

Example add_property() command line usage:

>>> add_property(property_name='stats.testPropertyNum', value=12) 
done

Example add_property() script usage:

import sys
from jaws import *

login()
print 'begin' 
try:
    print add_property(property_name='stats.testPropertyNum', value=15) 

    print 'end'

finally:
    logout()

jaws_numeric_property_value()

Get the numeric value associated with the given property.

Parameters:

• property_name - the name of the AAI property to get the numeric value for

Dependencies:

• Must be logged in as admin

Result:

• The integer value associated with given property

Example jaws_numeric_property_value() command line usage:

>>> jaws_numeric_property_value(property_name='stats.testPropertyNum') 
done
99

>>> jaws_numeric_property_value('stats.testPropertyNum')

Example jaws_numeric_property_value() script usage:

import sys
from jaws import *

login()
print 'begin' 
try:
    props = jaws_properties() 
    for p in props:
      print p + ": " + str(jaws_numeric_property_value(p)) 

    print 'end'

finally:
    logout()

jaws_properties()

Get a list of names of all AAI properties.

Parameters:

• None

Dependencies:

• Must be logged in

Result:

• A list of names of AAI properties

Example jaws_properties() command line usage:

>>> jaws_properties()
[u'client.jawsServerDescription', u'client.jawsServerId', 
u'tidal.sinceDaysForJammer', u'converterPollingInterval', 
u'db.schema.version', u'statisticsPollingInterval', 
u'jammerPollingInterval', u'license', u'converterStartTime', 
u'statisticsStartTime']

Example jaws_properties() script usage:

import sys
from jaws import *

login()
print 'begin' 
try:
    props = jaws_properties() 
    for p in props:
      print p 

    print 'end'

finally:
    logout()

jaws_string_property_value()

Get the string value associated with the given property name.

Parameters:

• property_name - the name of the AAI property to get the string value for

Dependencies:

• Must be logged in as admin

Result:

• The string value associated with given property

Example jaws_string_property_value() command line usage:

>>> jaws_string_property_value(property_name='client.jawsServerId') 
done
u'JAWS'

>>> jaws_string_property_value('client.jawsServerId')

Example jaws_string_property_value() script usage:

import sys
from jaws import *

login()
print 'begin' 
try:
    props = jaws_properties() 
    for p in props:
      print p + ": " + str(jaws_string_property_value(p)) 

    print 'end'

finally:
    logout()

update_property()

Update an existing AAI property with the specified name and value.

Parameters:

• property_name - the name of the AAI property to be updated
• value - the new value of the specified AAI property

Dependencies:

• Must be logged in
• Must have at least one existing AAI property

Result:

• Given property updated with new value

Example update_property() command line usage:

>>> update_property(property_name='stats.testPropertyNum', value=12 ) 
done

Example update_property() script usage:

import sys
from jaws import *

login()
print 'begin' 
try:
    print update_property(property_name='stats.testPropertyNum', value=27) 

    print 'end'

finally:
    logout()