Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation  Back up to About Overview 
  
[+] Expand All
[-] Collapse All

Client Request Examples

The following examples show the XML format of a client request.

Example: Query

This example performs a query for up to 1000 sessions with any username:

  <envelope>
    <header />
    <body>
      <request action="query" force="true" session_limit="1000">
        <attributes>
          <attribute enabled="true" name="User-Name" value="*" />
        </attributes>
      </request>
    </body>
  </envelope>

Example: Query

This example performs a query for up to 1000 sessions with any username beginning with the letter ‘A’:

  <envelope>
    <header />
    <body>
      <request action="query" force="true" session_limit="1000">
        <attributes>
          <attribute enabled="true" name="User-Name" value="A*" />
        </attributes>
      </request>
    </body>
  </envelope>

Example: RADIUS Disconnect

This example performs a RADIUS Disconnect against a specific session, using a handle previously obtained in a query:

  <envelope>
    <header />
    <body>
      <request action="disconnect">
        <attributes>
          <attribute name="Funk-Session-Handle" value="41f7e1780000000a" />
        </attributes>
      </request>
    </body>
  </envelope>

Example: RADIUS Disconnect

This example performs a RADIUS Disconnect against all users whose names start with “Test” unless there are more than 10 such users, in which case no action is taken:

  <envelope>
    <header />
    <body>
      <request action="disconnect" force="false" session_limit="10">
        <attributes>
          <attribute enabled="true" name="User-Name" value="Test*" />
        </attributes>
      </request>
    </body>
  </envelope>

Example: RADIUS Disconnect

This example performs a RADIUS Disconnect against 3 specific sessions identified by handles obtained in previous queries:

  <envelope>
    <header />
    <body>
      <request action="disconnect">
        <attributes>
          <attribute name="Funk-Session-Handle" value="41f7e17800000003" />
          <attribute name="Funk-Session-Handle" value="41f7e17800000005" />
          <attribute name="Funk-Session-Handle" value="41f7e17800000008" />
        </attributes>
      </request>
    </body>
  </envelope>

Example: (CoA) Action Called Intercept

This example performs an action called Intercept for up to 10 sessions of the user, named “Bob”:

  <envelope>
    <header />
    <body>
      <request action="intercept" force=“true”  session_limit=“10” >
        <attributes>
          <attribute enabled="true" name="User-Name" value="Bob" />
        </attributes>
      </request>
    </body>
  </envelope>

Modified: 2017-03-07