Config.get - Tied Variable Examples

The config.get method can also be used to get the values of variables that are dependent upon, or "tied to" other variables.

Example 1: Get the value of a global tied variable

This example gets the netmask value, httpd_acl_ip_config_netmask, tied to the Allowed API IP/Range value, httpd_acl_ip_config_address, set on the BASIC > Administration page. These IP addresses allow access to the Barracuda Email Security Gateway via SNMP queries to retrieve error information or to administer the system via the API. In the request, the IP address is specified in the path. These variables appear in the configuration like this:

# API/SNMP IP Address List
httpd_acl_ip_config_address = 192.168.1.1
# API/SNMP IP Netmask List
httpd_acl_ip_config_netmask = 255.255.128.0

Arguments

type: httpd_acl_ip_config_address
path: 192.168.1.1
variable: httpd_acl_ip_config_netmask

Sample Request

<?XML version="1.0" encoding="UTF8"?>
     <methodCall>                     
           <methodName>config.get</methodName>            
     <params>
      <param>
        <value>
         <struct>
           <member>
           <name>variable</name> 
             <value><string> <![CDATA[httpd_acl_ip_config_netmask]]> </string> 
         </value>
         </member>
           <member>            
               <name>path</name>
               <value><string>< ![CDATA[ * 192.168.1.1 * ]]> ></string>          
               </value>
         </member>
          <member>            
             <name>type</name>
              <value>
                 <string><![CDATA[httpd_acl_ip_config_address]]></string>                 
             </value>
        </member>  
       </struct>
     </param>    
  </params>
   </methodCall>

Response

 OK <?XML version="1.0" encoding="UTF8"?>
   <methodResponse>
    <params>
     <param>
      <value>
       <string>![CDATA[255.255.128.0]]</string> 
       </value>              
      </param>    
      </params>    
  </methodResponse>

Example 2: Get the value of a global tied variable

This example gets the action (Block, Tag, Quarantine) currently assigned to a custom reputation block list (RBL) which can be set from the BLOCK/ACCEPT > IP Reputation page in the web interface. The call gets the value of the mta_rbl_custom_action variable, which is set to "Block", corresponding to the mta_rbl_custom_name sbl.spamblocklist.org, which is under global scope. These variables appear in the configuration like this:

# Custom RBL Action List
mta_rbl_custom_action = Block
# Custom RBL List
mta_rbl_custom_name = sbl.spamblocklist.org

Arguments

type: 'mta_rbl_custom_name'
path: 'sbl.spamblocklist.org'
variable: 'mta_rbl_custom_action'

Sample Request

 <?XML version="1.0" encoding="UTF8"?>
 <methodCall>
  <methodName>config.get</methodName>
   <params>
    <param>
     <value>
      <struct>
 <member>
  <name>variable</name>
          <value>
           <string><![CDATA[mta_rbl_custom_action]]></string>
          </value>
 </member>
 <member>
  <name>path</name>
          <value>
           <string><![CDATA[sbl.spamblocklist.org]]></string>
          </value>
 </member>
 <member>
         <name>type</name>
          <value>
           <string><![CDATA[mta_rbl_custom_name]]></string>
          </value>
 </member>
</struct>
     </value>
    </param>
   </params>
 </methodCall>

Response

 <?XML version="1.0" encoding="UTF8"?>
   <methodResponse>
     <params>
       <param>
<value>
  <string><![CDATA[Block]]></string>
</value>
       </param>
    </params>
  </methodResponse>

Example 3: Get the value of a per-domain tied variable

This example gets the netmask currently assigned to a configured IP Allow List, which can be set from the BLOCK/ACCEPT > IP Filters page in the web interface. The call gets the value of the mta_acl_ip_allow_netmask variable, which is set to "255.255.255.255", corresponding to the mta_acl_ip_allow_address 2.2.2.2, which is under domain scope with scope_data of thisdomain.net. These variables appear in the configuration like this:

# Allow List Netmask
mta_acl_ip_allow_netmask = 255.255.255.255
# Allow List Address
mta_acl_ip_allow_address = 2.2.2.2

Arguments

type: 'mta_acl_ip_allow_address'
path: 'thisdomain.net:2.2.2.2'
variable: 'mta_acl_ip_allow_comment'

Sample Request

 <?XML version="1.0" encoding="UTF8"?>
     <methodCall>                     
           <methodName>config.get</methodName>            
     <params>
      <param>
        <value>
         <struct>
           <member>
           <name>variable</name> 
             <value><string> <![CDATA[mta_acl_ip_allow_comment]]> </string> 
         </value>
         </member>
           <member>
           <name>path</name> 
           <value><string><![CDATA[thisdomain.net:2.2.2.2]]></string> 
         </value>
         </member>
          <member>
           <name>type</name> 
            <value>
            <string><![CDATA[mta_acl_ip_allow_address]]></string>          
         </value>
        </member>  
       </struct>
     </param>    
  </params>
   </methodCall>

Response

 OK <?XML version="1.0" encoding="UTF8"?>
   <methodResponse>
    <params>
     <param>
      <value>
       <string><![CDATA[255.255.255.255]]></string> 
       </value>              
      </param>    
      </params>    
  </methodResponse>