parentalcontrol:subscriberrecord : Parental control subscriber record object.¶
This object represents a set of parental control properties for subscriber record.
Object Reference¶
References to parentalcontrol:subscriberrecord are object references.
The IP/Prefix/LocalId/IPSD part of the subscriberrecord object reference has the following components:
IP: IP Address of the subscriberrecord.
Prefix: Prefix length for IP Address of the subscriberrecord.
LocalId: Local Id of the subscriberrecord.
IPSD: IP Address Space Discriminator of the subscriberrecord.
- Example:
- “parentalcontrol:subscriberrecord/
- MTAuMTAuMTAuMTAkMzIkYTBiMGMwZDBlMGYwJEJMUg:10.10.10.10/32/
a0b0c0d0e0f0/BLR”
Restrictions¶
The object does not support the following operations:
Global search (searches via the search object)
Scheduling
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): accounting_session_id, ip_addr, ipsd, localid, prefix, site, subscriber_id.
The following fields are required to create this object:
Field |
Notes |
|---|---|
ip_addr |
|
ipsd |
|
localid |
|
prefix |
|
site |
|
subscriber_id |
accounting_session_id¶
- accounting_session_id¶
accounting_session_id
Type
String.
Create
The default value is undefined.
Search
The field is not available for search.
Notes
The accounting_session_id is part of the base object.
alt_ip_addr¶
- alt_ip_addr¶
alt_ip_addr
Type
String.
Create
The default value is undefined.
Search
The field is not available for search.
ans0¶
- ans0¶
ans0
Type
String.
Create
The default value is undefined.
Search
The field is not available for search.
ans1¶
- ans1¶
ans1
Type
String.
Create
The default value is undefined.
Search
The field is not available for search.
ans2¶
- ans2¶
ans2
Type
String.
Create
The default value is undefined.
Search
The field is not available for search.
ans3¶
- ans3¶
ans3
Type
String.
Create
The default value is undefined.
Search
The field is not available for search.
ans4¶
- ans4¶
ans4
Type
String.
Create
The default value is undefined.
Search
The field is not available for search.
black_list¶
- black_list¶
black_list
Type
String.
Create
The default value is undefined.
Search
The field is not available for search.
bwflag¶
- bwflag¶
bwflag
Type
Bool.
Create
The default value is undefined.
Search
The field is not available for search.
dynamic_category_policy¶
- dynamic_category_policy¶
dynamic_category_policy
Type
Bool.
Create
The default value is undefined.
Search
The field is not available for search.
flags¶
- flags¶
flags
Type
String.
Create
The default value is undefined.
Search
The field is not available for search.
ip_addr¶
- ip_addr¶
ip_addr
Type
String.
Create
The field is required on creation.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
Notes
The ip_addr is part of the base object.
ipsd¶
- ipsd¶
ipsd
Type
String.
Create
The field is required on creation.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
Notes
The ipsd is part of the base object.
localid¶
- localid¶
localid
Type
String.
Create
The field is required on creation.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
Notes
The localid is part of the base object.
nas_contextual¶
- nas_contextual¶
nas_contextual
Type
String.
Create
The default value is undefined.
Search
The field is not available for search.
op_code¶
- op_code¶
op_code
Type
String.
Create
The default value is undefined.
Search
The field is not available for search.
parental_control_policy¶
- parental_control_policy¶
parental_control_policy
Type
String.
Create
The default value is undefined.
Search
The field is not available for search.
prefix¶
- prefix¶
prefix
Type
Unsigned integer.
Create
The field is required on creation.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The prefix is part of the base object.
proxy_all¶
- proxy_all¶
proxy_all
Type
Bool.
Create
The default value is undefined.
Search
The field is not available for search.
site¶
- site¶
site
Type
String.
Create
The field is required on creation.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
Notes
The site is part of the base object.
subscriber_id¶
- subscriber_id¶
subscriber_id
Type
String.
Create
The field is required on creation.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
Notes
The subscriber_id is part of the base object.
subscriber_secure_policy¶
- subscriber_secure_policy¶
subscriber_secure_policy
Type
String.
Create
The default value is undefined.
Search
The field is not available for search.
unknown_category_policy¶
- unknown_category_policy¶
unknown_category_policy
Type
Bool.
Create
The default value is undefined.
Search
The field is not available for search.
white_list¶
- white_list¶
white_list
Type
String.
Create
The default value is undefined.
Search
The field is not available for search.
wpc_category_policy¶
- wpc_category_policy¶
wpc_category_policy
Type
String.
Create
The default value is undefined.
Search
The field is not available for search.
Fields List¶
Field |
Type |
Req |
R/O |
Base |
Search |
|---|---|---|---|---|---|
accounting_session_id |
String |
N |
N |
Y |
N/A |
alt_ip_addr |
String |
N |
N |
N |
N/A |
ans0 |
String |
N |
N |
N |
N/A |
ans1 |
String |
N |
N |
N |
N/A |
ans2 |
String |
N |
N |
N |
N/A |
ans3 |
String |
N |
N |
N |
N/A |
ans4 |
String |
N |
N |
N |
N/A |
black_list |
String |
N |
N |
N |
N/A |
bwflag |
Bool |
N |
N |
N |
N/A |
dynamic_category_policy |
Bool |
N |
N |
N |
N/A |
flags |
String |
N |
N |
N |
N/A |
ip_addr |
String |
Y |
N |
Y |
: = ~ |
ipsd |
String |
Y |
N |
Y |
: = ~ |
localid |
String |
Y |
N |
Y |
: = ~ |
nas_contextual |
String |
N |
N |
N |
N/A |
op_code |
String |
N |
N |
N |
N/A |
parental_control_policy |
String |
N |
N |
N |
N/A |
prefix |
Unsigned int |
Y |
N |
Y |
= |
proxy_all |
Bool |
N |
N |
N |
N/A |
site |
String |
Y |
N |
Y |
: = ~ |
subscriber_id |
String |
Y |
N |
Y |
: = ~ |
subscriber_secure_policy |
String |
N |
N |
N |
N/A |
unknown_category_policy |
Bool |
N |
N |
N |
N/A |
white_list |
String |
N |
N |
N |
N/A |
wpc_category_policy |
String |
N |
N |
N |
N/A |
