parentalcontrol:avp : The parental control AVP object.¶
The accounting attribute value pair object is used to extract accounting information from accounting protocols logs.
Object Reference¶
References to parentalcontrol:avp are object references.
The name part of the parentalcontrol:avp object reference has the following components:
The name of the AVP.
- Example:
parentalcontrol:avp/ b25lLmltY19hY2NvdW50aW5nX2F2cCR0ZXRyYW5vZGU:tetranode
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, type, value_type.
The following fields are required to create this object:
Field |
Notes |
|---|---|
name |
|
type |
|
value_type |
|
vendor_id |
You must specify vendor_id when type is 26. |
vendor_type |
You must specify vendor_type when type is 26. |
comment¶
- comment¶
The comment for the AVP.
Type
String.
Create
The default value is empty.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
domain_types¶
- domain_types¶
The list of domains applicable to AVP.
Type
Enum values array.
- Valid values are:
ANCILLARY
IP_SPACE_DIS
NAS_CONTEXT
SUBS_ID
Create
The default value is empty.
Search
The field is not available for search.
is_restricted¶
- is_restricted¶
Determines if AVP is restricted to domains.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
name¶
- name¶
The name of AVP.
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.
type¶
- type¶
The type of AVP as per RFC 2865/2866.
Type
Unsigned integer.
Create
The field is required on creation.
Search
The field is not available for search.
Notes
The type is part of the base object.
user_defined¶
- user_defined¶
Determines if AVP was defined by user.
Type
Bool.
Search
The field is not available for search.
Notes
The user_defined cannot be updated.
user_defined cannot be written.
value_type¶
- value_type¶
The type of value.
Type
String.
- Valid values are:
BYTE
DATE
INTEGER
INTEGER64
IPADDR
IPV6ADDR
IPV6IFID
IPV6PREFIX
OCTETS
SHORT
STRING
Create
The field is required on creation.
Search
The field is not available for search.
Notes
The value_type is part of the base object.
vendor_id¶
- vendor_id¶
The vendor ID as per RFC 2865/2866.
Type
Unsigned integer.
Create
You must specify vendor_id when type is 26.
Search
The field is available for search via
‘=’ (exact equality)
vendor_type¶
- vendor_type¶
The vendor type as per RFC 2865/2866.
Type
Unsigned integer.
Create
You must specify vendor_type when type is 26.
Search
The field is available for search via
‘=’ (exact equality)
Fields List¶
Field |
Type |
Req |
R/O |
Base |
Search |
|---|---|---|---|---|---|
comment |
String |
N |
N |
N |
: = ~ |
domain_types |
[Enum] |
N |
N |
N |
N/A |
is_restricted |
Bool |
N |
N |
N |
N/A |
name |
String |
Y |
N |
Y |
: = ~ |
type |
Unsigned int |
Y |
N |
Y |
N/A |
user_defined |
Bool |
N |
Y |
N |
N/A |
value_type |
String |
Y |
N |
Y |
N/A |
vendor_id |
Unsigned int |
Y* |
N |
N |
= |
vendor_type |
Unsigned int |
Y* |
N |
N |
= |
* Required in some cases, see detailed field description above.
