SRC PCMM Web Service Interface Methods

This section describes the methods in the SRC PCMM Web service interface.

CommitResources

• Specifies the resources that are being requested in the CommitResource message.

• Argument—CommitResourcesReq
  • classifier—Object that identifies the traffic flow that the application server is requesting services for. The object contains:
    • protocol
    • sourceIpAddress
    • sourceIpMask
    • sourcePortStart
    • sourcePortEnd
    • destinationIpAddress
    • destinationIpMask
    • destinationPortStart
    • destinationPortEnd

    For more information, see Configuring Classify-Traffic Conditions for Dynamic Service Activator.

  • trafficProfile—Provides information about the bandwidth and QoS characteristics desired for a request. You express the traffic profile through SRC policies. You can configure the policies one of the following ways:
    • FlowSpec action—See Configuring FlowSpec Actions for Dynamic Service Activator.
    • Specifying a traffic class in the service class name action—See Configuring Service Class Name Actions for Dynamic Service Activator.
    • Bandwidth parameter—See Configuring DOCSIS Actions for Dynamic Service Activator.
  • TimeUsageLimit—Specifies, in seconds, a limit on the lifetime of a context. An application server may specify multiple TimeUsageLimit elements to request different limits in the upstream and downstream directions. If the application server does not specify a TimeUsageLimit, the application manager determines the TimeUsageLimit.
  • SubscriberID—IPv4 address or SubscriberURI
    • If a subscriber URI and an IPv4 address are provided, the IPv4 address is ignored.
    • If the IPv4 address is supplied and the subscriber URI is not supplied, then a subscriber URI is constructed with the given IPv4 address as an assignedIp subscriber type (sidType is SIT_ADDR_IF_NAME).
  • ServiceName—Name of SRC service
  • contextID—Globally unique identifier that the application manager must use if it is included in the message

    The context ID is used as the SRC sessionName when the PCMM gateway activates a service.

• Expected output—CommitResourcesRsp. The CommitResourcesRsp object contains the ContextID of the activated service.

ReleaseResources

• Specifies the resources that are being requested to be released in the ReleaseResources message.

• Argument—ReleaseResourcesReq
  • Subscriber URI—IP address of the subscriber
  • ServiceName—Name of SRC service
  • contextID—Globally unique identifier that the application manager must use if it is included in the message

    The context ID is used as the SRC sessionName when the PCMM gateway activates a service.

• Expected output—ReleaseResourcesRsp

QueryAvailableServices

• Searches for the services that are available to the calling application.

• Expected output—QueryAvailableServicesRsp

QueryContexts

• Searches for the context ID and context status for a subscriber.

• Argument—QueryContextsReq
  • SubscriberID—IPv4 address or SubscriberURI
    • If a subscriber URI and an IPv4 address is provided, the IPv4 address is ignored.
    • If the IPv4 address is supplied and the subscriber URI is not supplied, then a subscriber URI is constructed with the given IPv4 address as an assignedIp subscriber type (sidType is SIT_ADDR_IF_NAME).
  • ServiceName—Name of SRC service
  • contextID—Globally unique identifier that the application manager must use if it is included in the message

    The context ID is used as the SRC sessionName when the PCMM gateway activates a service.

• Expected output—QueryContextsRsp