Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation
Guide That Contains This Content
[+] Expand All
[-] Collapse All

    Format of the Subscriber’s URI

    Many of Dynamic Service Activator’s methods require the argument subURI, the subscriber’s Uniform Resource Identifier (URI). This argument comprises two portions: the type of subscriber (subscriber-type) and a list of the subscriber’s attributes (subscriber-comp). The syntax for the subURI argument is:

    <subscriber-type>:<subscriber-comp> [& <subscriber-comp>]*

    The <subscriber-type> variable is the name of the Subscriber Type instance that is defined in the directory during the Dynamic Service Activator configuration. For example, the sample data provides these Subscriber Type instances for the <subscriber-type> value:

    • ip—The sidType is SIT_ADDRESS
    • dn—The sidType is SIT_DN
    • login—The sidType is SIT_LOGIN_NAME
    • assignedIp—The sidType is SIT_ADDR_IF_NAME
    • intName—The sidType is SIT_IF_NAME
    • intIndex—The sidType is SIT_IF_INDEX

    The <subscriber-comp> variable has the format <type>=<value>.

    • <type> can be one of the following:
      • ipAddress—Subscriber’s IP address; mandatory when the sidType is SIT_ADDRESS or SIT_ADDR_IF_NAME
      • timestamp—Time at which the request was sent; optional when the sidType is SIT_ADDRESS
      • dn—Subscriber’s DN; mandatory when the sidType is SIT_DN
      • intfName—Name of the interface on which the subscriber logs in; mandatory when the sidType is SIT_IF_NAME, optional when the sidType is SIT_ADDR_IF_NAME
      • vrfName—Name of the VRF associated with the subscriber; mandatory when the sidType is SIT_IF_NAME or SIT_IF_INDEX, optional when the sidType is SIT_ADDR_IF_NAME
      • login_name—Name with which the subscriber logs in; mandatory when the sidType is SIT_LOGIN_NAME
      • intfIndex—SNMP index of the interface on which the subscriber logs in; mandatory when the sidType is SIT_IF_INDEX
      • primary_user_name—Primary username; mandatory when the sidType is SIT_PRIMARY_USER_NAME
    • <value> can be a combination of the following:
      • <operator>—One of the following:

        ; | / | ? | : | @ | & | = | + | $ | ,

      • <textString>—Text string that uses the following characters:
        • Lowercase letters
        • Uppercase letters
        • Arabic numerals
        • - | _ | . | ! | ~ | * | ' | ( | )
      • % <hexNumber>—2-character hexadecimal number

    For example, you can use the following subscriber’s URI to look up a subscriber by IP address as specified by the sample data:

    ip:ipAddress=192.168.1.10

    The sample data defines a subscriber type named ip, whose sidType is SIT_ADDRESS and nicProxyNamespace is /nicProxies/ip. As a result, ip is the value of the <subscriber-type> variable. Because the sidType is SIT_ADDRESS, ipAddress is mandatory for the <type> component, and the subscriber’s IP address is the <value> component of the <subscriber-comp> variable.

    Modified: 2016-12-29