parentalcontrol:subscriber : The parental control subscriber object.

The parental control subscriber properties contains user defined RADIUS subscriber information which will be used by DNS/RPZ for reporting and logging violations.

Object Reference

References to parentalcontrol:subscriber are object references.

The name part of the parentalcontrol:subscriber object reference has the following components:

  • The name of AVP used as a subscriber.
Example:
parentalcontrol:subscriber/ b25lLmltY19zdWJzY3JpYmVyX3NlY3VyZV9wcm9wZXJ0aWVzJDA:IMSI

Restrictions

The object does not support the following operations:

The object cannot be managed on Cloud Platform members.

Fields

These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.

The basic version of the object contains the field(s): alt_subscriber_id, local_id, subscriber_id.

alt_subscriber_id

alt_subscriber_id

The name of AVP to be used as an alternate subscriber ID for fixed lines.

Type

String.

Create

The default value is empty.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The alt_subscriber_id is part of the base object.

alt_subscriber_id_regexp

alt_subscriber_id_regexp

A character string to control aspects of rewriting of the fields.

Type

String.

Create

The default value is empty.

Search

The field is not available for search.

alt_subscriber_id_subexpression

alt_subscriber_id_subexpression

The subexpression indicates which subexpression to extract. If zero, then the text matching the entire regular expression is extracted. If non-zero, then the regex must contain at least that many sub-expression groups. It takes values from 0 to 8.

Type

Unsigned integer.

Create

The default value is 0.

Search

The field is not available for search.

ancillaries

ancillaries

The list of ordered AVP Ancillary Fields.

Type

String array.

Create

The default value is empty.

Search

The field is not available for search.

cat_acctname

cat_acctname

Category content account name using the categorization service.

Type

String.

Create

The default value is empty.

Search

The field is not available for search.

cat_password

cat_password

Category content account password to access the categorization service.

Type

String.

Create

The default value is empty.

Search

The field is not available for search.

cat_update_frequency

cat_update_frequency

Category content updates every number of hours.

Type

Unsigned integer.

Create

The default value is 24.

Search

The field is not available for search.

category_url

category_url

Category content vendor url to download category data from and upload feedback to, configure for parental control.

Type

String.

Create

The default value is http://pitchers.rulespace.com/ufsupdate/web.pl.

Search

The field is not available for search.

enable_mgmt_only_nas

enable_mgmt_only_nas

Determines if NAS RADIUS traffic is accepted over MGMT only.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

enable_parental_control

enable_parental_control

Determines if parental control is enabled.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

ident

ident

Category content authorization string per customer for remote RD lookup and category access.

Type

String.

Create

The default value is empty.

Search

The field is not available for search.

interim_accounting_interval

interim_accounting_interval

The time for collector to be fully populated.

Valid values are from 1 to 65535.

Type

Unsigned integer.

Create

The default value is 720.

Search

The field is not available for search.

ip_anchors

ip_anchors

The ordered list of IP Anchors AVPs. The list content cannot be changed, but the order of elements.

Type

String array.

Create

The default value is [‘Framed-IPv6-Address’, ‘Framed-IPv6-Prefix’, ‘Delegated-IPv6-Prefix’].

Search

The field is not available for search.

ip_space_disc_regexp

ip_space_disc_regexp

A character string to control aspects of rewriting of the fields.

Type

String.

Create

The default value is empty.

Search

The field is not available for search.

ip_space_disc_subexpression

ip_space_disc_subexpression

The subexpression indicates which subexpression to extract. If zero, then the text matching the entire regular expression is extracted. If non-zero, then the regex must contain at least that many sub-expression groups. It takes values from 0 to 8.

Type

Unsigned integer.

Create

The default value is 0.

Search

The field is not available for search.

ip_space_discriminator

ip_space_discriminator

The name of AVP to be used as IP address discriminator.

Type

String.

Create

The default value is empty.

Search

The field is not available for search.

local_id

local_id

The name of AVP to be used as local ID.

Type

String.

Create

The default value is empty.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The local_id is part of the base object.

local_id_regexp

local_id_regexp

A character string to control aspects of rewriting of the fields.

Type

String.

Create

The default value is empty.

Search

The field is not available for search.

local_id_subexpression

local_id_subexpression

The subexpression indicates which subexpression to extract. If zero, then the text matching the entire regular expression is extracted. If non-zero, then the regex must contain at least that many sub-expression groups. It takes values from 0 to 8.

Type

Unsigned integer.

Create

The default value is 0.

Search

The field is not available for search.

log_guest_lookups

log_guest_lookups
CEF log all guest lookups, will produce two logs in
case of a violation.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

nas_context_info

nas_context_info

NAS contextual information AVP.

Type

String.

Create

The default value is NAS-PORT.

Search

The field is not available for search.

pc_zone_name

pc_zone_name

The SOA to store parental control records.

Type

String.

Create

The default value is empty.

Search

The field is not available for search.

proxy_password

proxy_password

Proxy server password used for authentication.

Type

String.

Create

The default value is empty.

Search

The field is not available for search.

proxy_url

proxy_url

Proxy url to download category data from and upload feedback to, configure for parental control. The default value ‘None’ is no longer valid as it match url regex pattern “^http|https://”. The new default value does not get saved in database, but rather used for comparision with object created in unit test cases.

Type

String.

Create

The default value is http://dummyproxy.com:4444.

Search

The field is not available for search.

proxy_username

proxy_username

Proxy server username used for authentication.

Type

String.

Create

The default value is empty.

Search

The field is not available for search.

subscriber_id

subscriber_id

The name of AVP to be used as a subscriber.

Type

String.

Create

The default value is Calling-Station-Id.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The subscriber_id is part of the base object.

subscriber_id_regexp

subscriber_id_regexp

A character string to control aspects of rewriting of the fields.

Type

String.

Create

The default value is empty.

Search

The field is not available for search.

subscriber_id_subexpression

subscriber_id_subexpression

The subexpression indicates which subexpression to extract. If zero, then the text matching the entire regular expression is extracted. If non-zero, then the regex must contain at least that many sub-expression groups. It takes values from 0 to 8.

Type

Unsigned integer.

Create

The default value is 0.

Search

The field is not available for search.

Fields List

Field Type Req R/O Base Search
alt_subscriber_id String N N Y =
alt_subscriber_id_regexp String N N N N/A
alt_subscriber_id_subexpression Unsigned int N N N N/A
ancillaries [String] N N N N/A
cat_acctname String N N N N/A
cat_password String N N N N/A
cat_update_frequency Unsigned int N N N N/A
category_url String N N N N/A
enable_mgmt_only_nas Bool N N N N/A
enable_parental_control Bool N N N N/A
ident String N N N N/A
interim_accounting_interval Unsigned int N N N N/A
ip_anchors [String] N N N N/A
ip_space_disc_regexp String N N N N/A
ip_space_disc_subexpression Unsigned int N N N N/A
ip_space_discriminator String N N N N/A
local_id String N N Y =
local_id_regexp String N N N N/A
local_id_subexpression Unsigned int N N N N/A
log_guest_lookups Bool N N N N/A
nas_context_info String N N N N/A
pc_zone_name String N N N N/A
proxy_password String N N N N/A
proxy_url String N N N N/A
proxy_username String N N N N/A
subscriber_id String N N Y =
subscriber_id_regexp String N N N N/A
subscriber_id_subexpression Unsigned int N N N N/A