networkuser : Network User object.¶
The DHCP Network User object provides information about Active Directory users such as user session for a specific IP address, domain, login and logout timestamps.
Object Reference¶
References to networkuser are object references.
The name part of a Network User reference has the following components:
Name of Network User
Name of the network view
Example: networkuser/ZG5zLm5ldHdvcmtfdmlldyQxMTk:NetworkUser1/external
Restrictions¶
The object does not support the following operations:
Scheduling
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): address, domainname, name, network_view, user_status.
The following fields are required to create this object:
Field |
Notes |
|---|---|
address |
|
domainname |
|
first_seen_time |
|
guid |
|
logon_id |
|
name |
|
network_view |
address¶
- address¶
The IPv4 Address or IPv6 Address of the Network User.
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 address is part of the base object.
address_object¶
- address_object¶
The reference of the IPAM IPv4Address or IPv6Address object describing the address of the Network User.
Type
String.
This field supports nested return fields as described here.
Search
The field is not available for search.
Notes
The address_object cannot be updated.
address_object cannot be written.
data_source¶
- data_source¶
The Network User data source.
Type
String.
Search
The field is not available for search.
Notes
The data_source cannot be updated.
data_source cannot be written.
data_source_ip¶
- data_source_ip¶
The Network User data source IPv4 Address or IPv6 Address or FQDN address.
Type
String.
Search
The field is not available for search.
Notes
The data_source_ip cannot be updated.
data_source_ip cannot be written.
domainname¶
- domainname¶
The domain name of the Network User.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The field is required on creation.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
Notes
The domainname is part of the base object.
first_seen_time¶
- first_seen_time¶
The first seen timestamp of the Network User.
Type
Timestamp.
Create
The field is required on creation.
Search
The field is not available for search.
guid¶
- guid¶
The group identifier of the Network User.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The field is required on creation.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
last_seen_time¶
- last_seen_time¶
The last seen timestamp of the Network User.
Type
Timestamp.
Create
The default value is undefined.
Search
The field is not available for search.
last_updated_time¶
- last_updated_time¶
The last updated timestamp of the Network User.
Type
Timestamp.
Create
The default value is undefined.
Search
The field is not available for search.
logon_id¶
- logon_id¶
The logon identifier of the Network User.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The field is required on creation.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
logout_time¶
- logout_time¶
The logout timestamp of the Network User.
Type
Timestamp.
Create
The default value is empty.
Search
The field is not available for search.
name¶
- name¶
The name of the Network User.
Type
String.
Values with leading or trailing white space are not valid for this field.
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.
network¶
- network¶
The reference to the network to which the Network User belongs.
Type
String.
This field supports nested return fields as described here.
Search
The field is not available for search.
Notes
The network cannot be updated.
network cannot be written.
network_view¶
- network_view¶
The name of the network view in which this Network User resides.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The field is required on creation.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The network_view is part of the base object.
user_status¶
- user_status¶
The status of the Network User.
Type
String.
- Valid values are:
ACTIVE
LOGOUT
TIMEOUT
Search
The field is available for search via
‘=’ (exact equality)
Notes
The user_status is part of the base object.
The user_status cannot be updated.
user_status cannot be written.
Search-only Fields¶
These fields are used only for searching. They are not actual members of the object and therefore the server does not return these fields with this name unless they are nested return fields.
parent¶
- parent¶
The reference to the parent object to which the Network User belongs.
Type
String.
This field supports nested return fields as described here.
Search
The field is available for search via
‘=’ (exact equality)
Notes
parent is a search-only field.
Fields List¶
Field |
Type |
Req |
R/O |
Base |
Search |
|---|---|---|---|---|---|
address |
String |
Y |
N |
Y |
: = ~ |
address_object |
String |
N |
Y |
N |
N/A |
data_source |
String |
N |
Y |
N |
N/A |
data_source_ip |
String |
N |
Y |
N |
N/A |
domainname |
String |
Y |
N |
Y |
: = ~ |
first_seen_time |
Timestamp |
Y |
N |
N |
N/A |
guid |
String |
Y |
N |
N |
: = ~ |
last_seen_time |
Timestamp |
N |
N |
N |
N/A |
last_updated_time |
Timestamp |
N |
N |
N |
N/A |
logon_id |
String |
Y |
N |
N |
: = ~ |
logout_time |
Timestamp |
N |
N |
N |
N/A |
name |
String |
Y |
N |
Y |
: = ~ |
network |
String |
N |
Y |
N |
N/A |
network_view |
String |
Y |
N |
Y |
= |
user_status |
String |
N |
Y |
Y |
= |
Search-only Fields List¶
Field |
Type |
Search |
|---|---|---|
parent |
String |
= |
