parentalcontrol:subscribersite : Subscriber site parental control properties object.¶
This object represents a set of parental control properties for subscriber site.
Object Reference¶
References to parentalcontrol:subscribersite are object references.
The name part of the parentalcontrol:subscribersite object reference has the following components:
The name of the site.
- Example:
parentalcontrol:subscribersite/ZG5zLm5ldHdvcmtfdmlldyQxMTk:wintermute
Restrictions¶
The object does not support the following operations:
CSV export
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): block_size, dca_sub_bw_list, dca_sub_query_count, enable_global_allow_list_rpz, enable_rpz_filtering_bypass, first_port, global_allow_list_rpz, name, stop_anycast, strict_nat.
The following fields are required to create this object:
Field |
Notes |
|---|---|
name |
abss¶
- abss¶
The list of ABS for the site.
Type
A/An Parental control additional blocking server(ABS) struct array.
Create
The default value is:
empty
Search
The field is not available for search.
api_members¶
- api_members¶
The list of API members for the site.
Type
A/An Site member parental control settings struct array.
Create
The default value is:
empty
Search
The field is not available for search.
api_port¶
- api_port¶
The port number for gRPC API server.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The api_port cannot be updated.
api_port cannot be written.
block_size¶
- block_size¶
The size of the Deterministic NAT block-size.
Type
Unsigned integer.
Create
The default value is 0.
Search
The field is not available for search.
Notes
The block_size is part of the base object.
blocking_ipv4_vip1¶
- blocking_ipv4_vip1¶
The IPv4 Address of the blocking server.
Type
String.
Create
The default value is empty.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
blocking_ipv4_vip2¶
- blocking_ipv4_vip2¶
The IPv4 Address of the blocking server.
Type
String.
Create
The default value is empty.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
blocking_ipv6_vip1¶
- blocking_ipv6_vip1¶
The IPv6 Address of the blocking server.
Type
String.
Create
The default value is empty.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
blocking_ipv6_vip2¶
- blocking_ipv6_vip2¶
The IPv6 Address of the blocking server.
Type
String.
Create
The default value is empty.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
comment¶
- comment¶
The human readable comment for the site.
Type
String.
Create
The default value is empty.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
dca_sub_bw_list¶
- dca_sub_bw_list¶
Enable/disable the DCA subscriber B/W list support.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
The dca_sub_bw_list is part of the base object.
dca_sub_query_count¶
- dca_sub_query_count¶
Enable/disable the DCA subscriber query count.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
The dca_sub_query_count is part of the base object.
enable_global_allow_list_rpz¶
- enable_global_allow_list_rpz¶
Enable/disable global allow list RPZ setting.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
The enable_global_allow_list_rpz is part of the base object.
enable_rpz_filtering_bypass¶
- enable_rpz_filtering_bypass¶
Enable/disable Subscriber Secure Policy Bypass for Allowed list.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
The enable_rpz_filtering_bypass is part of the base object.
extattrs¶
- extattrs¶
Extensible attributes associated with the object.
For valid values for extensible attributes, see the following information.
Type
Extensible attributes.
This field allows +/- to be specified as part of the field name when updating the object, see the following information.
Create
The default value is empty.
Search
For how to search extensible attributes, see the following information.
first_port¶
- first_port¶
The start of the first Deterministic block.
Type
Unsigned integer.
Create
The default value is 1024.
Search
The field is not available for search.
Notes
The first_port is part of the base object.
global_allow_list_rpz¶
- global_allow_list_rpz¶
Global allow list RPZ index. Valid values are between 0 and 63.
Type
Unsigned integer.
Create
The default value is empty.
Search
The field is not available for search.
Notes
The global_allow_list_rpz is part of the base object.
maximum_subscribers¶
- maximum_subscribers¶
The max number of subscribers for the site. It is used to configure the cache size.
Type
Unsigned integer.
Create
The default value is 1000000.
Search
The field is not available for search.
members¶
- members¶
The list of members for the site.
Type
A/An Site member parental control settings struct array.
Create
The default value is:
empty
Search
The field is not available for search.
msps¶
- msps¶
The list of MSP for the site.
Type
A/An Parental control managed service provider (MSP) service struct array.
Create
The default value is:
empty
Search
The field is not available for search.
name¶
- name¶
The name of the 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 name is part of the base object.
The name cannot be updated.
nas_gateways¶
- nas_gateways¶
The list of accounting log servers.
Type
A/An NAS gateway mobile security settings struct array.
Create
The default value is:
empty
Search
The field is not available for search.
nas_port¶
- nas_port¶
The port number to reach the collector.
Type
Unsigned integer.
Create
The default value is 1813.
Search
The field is not available for search.
proxy_rpz_passthru¶
- proxy_rpz_passthru¶
Enforce the global proxy list.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
spms¶
- spms¶
The list of SPM for the site.
Type
A/An Parental control policy management service (SPM) struct array.
Create
The default value is:
empty
Search
The field is not available for search.
stop_anycast¶
- stop_anycast¶
Stop the anycast service when the subscriber service is in the interim state.
Type
Bool.
Create
The default value is True.
Search
The field is not available for search.
Notes
The stop_anycast is part of the base object.
strict_nat¶
- strict_nat¶
Restrict subscriber cache entries to NATed clients.
Type
Bool.
Create
The default value is True.
Search
The field is not available for search.
Notes
The strict_nat is part of the base object.
subscriber_collection_type¶
- subscriber_collection_type¶
Subscriber collection type either RADIUS or API.
Type
String.
- Valid values are:
API
RADIUS
Create
The default value is RADIUS.
Search
The field is not available for search.
Fields List¶
Field |
Type |
Req |
R/O |
Base |
Search |
|---|---|---|---|---|---|
abss |
[struct] |
N |
N |
N |
N/A |
api_members |
[struct] |
N |
N |
N |
N/A |
api_port |
Unsigned int |
N |
Y |
N |
N/A |
block_size |
Unsigned int |
N |
N |
Y |
N/A |
blocking_ipv4_vip1 |
String |
N |
N |
N |
= ~ |
blocking_ipv4_vip2 |
String |
N |
N |
N |
= ~ |
blocking_ipv6_vip1 |
String |
N |
N |
N |
= ~ |
blocking_ipv6_vip2 |
String |
N |
N |
N |
= ~ |
comment |
String |
N |
N |
N |
: = ~ |
dca_sub_bw_list |
Bool |
N |
N |
Y |
N/A |
dca_sub_query_count |
Bool |
N |
N |
Y |
N/A |
enable_global_allow_list_rpz |
Bool |
N |
N |
Y |
N/A |
enable_rpz_filtering_bypass |
Bool |
N |
N |
Y |
N/A |
extattrs |
Extattr |
N |
N |
N |
ext |
first_port |
Unsigned int |
N |
N |
Y |
N/A |
global_allow_list_rpz |
Unsigned int |
N |
N |
Y |
N/A |
maximum_subscribers |
Unsigned int |
N |
N |
N |
N/A |
members |
[struct] |
N |
N |
N |
N/A |
msps |
[struct] |
N |
N |
N |
N/A |
name |
String |
Y |
N |
Y |
: = ~ |
nas_gateways |
[struct] |
N |
N |
N |
N/A |
nas_port |
Unsigned int |
N |
N |
N |
N/A |
proxy_rpz_passthru |
Bool |
N |
N |
N |
N/A |
spms |
[struct] |
N |
N |
N |
N/A |
stop_anycast |
Bool |
N |
N |
Y |
N/A |
strict_nat |
Bool |
N |
N |
Y |
N/A |
subscriber_collection_type |
String |
N |
N |
N |
N/A |
