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): name.

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.

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

  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

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

  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

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

  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

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

  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

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

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

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.

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

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

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.

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.

Fields List

Field Type Req R/O Base Search
abss [struct] N N N 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 : = ~
extattrs Extattr N N N ext
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
spms [struct] N N N N/A