Setting server properties with a server management request

A <SetProperty> tag contains one or more <prop> tags, each of which specifies a property to set. Each prop tag consists of a <client> tag, a <name> tag, and a <value> tag. To delete a property, omit the <value> tag.

<prop> subtags

Description

<client>

The name of the client for which to set a server property.

<name>

The name of the property to set.

<value>

The value of the property being set. If not included, the property gets deleted.

For an overview of how to use server management requests, including how to authenticate and schedule them, see Introduction to server management requests.

Example

The following server management request sets the ianywhere.qa.member.client3 property to Y for the destination alias called simpleGroup, which adds client3 to simpleGroup.

<?xml version="1.0" encoding="UTF-8"?>
<actions>
    <SetProperty>
     <prop>
        <client>simpleGroup</client>
        <name>ianywhere.qa.member.client3</name>
        <value>Y</value>
     </prop>
    </SetProperty>
</actions>

The next example does the following:

  • Creates or modifies the value of the client1 property myProp1 to 3.
  • Deletes the client1 property myProp2.
  • Modifies the value of the client2 property myProp3 to "some value".
<?xml version="1.0" encoding="UTF-8"?>
<actions>
    <SetProperty>
 <prop>
     <client>client1</client>
     <name>myProp1</name>
     <value>3</value>
 </prop>
 <prop>
     <client>client1</client>
     <name>myProp2</name>
 </prop>
 <prop>
     <client>client2</client>
     <name>myProp3</name>
     <value>some value</value>
 </prop>
    </SetProperty>
</actions>