tftpfiledir : TFTP file or directory object.¶
The TFTP file/directory object provides facilities for creating a directory structure for file distribution, modifying the directory name and permission, creating virtual TFTP root directories, and browsing the contents of the directories.
Note¶
Parameter directory is required for object searches.
Object Reference¶
References to tftpfiledir are object references.
The name part of the TFTP file/directory object reference has the following components:
The type of TFTP file or directory entity
The name of the TFTP file or directory entity
- Example:
tftpfiledir/ ZG5zLm9wdGlvbl9kZWZpbml0aW9uJGluZm8uLmZhbHNlLjI1Mg:dir1
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): directory, name, type.
The following fields are required to create this object:
Field |
Notes |
|---|---|
name |
|
type |
directory¶
- directory¶
The path to the directory that contains file or subdirectory.
Type
String.
Create
The default value is /.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The directory is part of the base object.
The directory cannot be updated.
is_synced_to_gm¶
- is_synced_to_gm¶
Determines whether the TFTP entity is synchronized to Grid Master.
Type
Bool.
Search
The field is not available for search.
Notes
The is_synced_to_gm cannot be updated.
is_synced_to_gm cannot be written.
last_modify¶
- last_modify¶
The time when the file or directory was last modified.
Type
Timestamp.
Search
The field is not available for search.
Notes
The last_modify cannot be updated.
last_modify cannot be written.
name¶
- name¶
The TFTP directory or file name.
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 TFTP file system entity (directory or file).
Type
String.
- Valid values are:
DIRECTORY
FILE
Create
The field is required on creation.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The type is part of the base object.
The type cannot be updated.
vtftp_dir_members¶
- vtftp_dir_members¶
The replication members with TFTP client addresses where this virtual folder is applicable.
Type
A/An Virtual TFTP directory member struct array.
Create
The default value is:
empty
Search
The field is not available for search.
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.
recursive¶
- recursive¶
Determines whether the recursive read is performed on directory.
Type
Bool.
Search
The field is available for search via
‘=’ (exact equality)
Notes
recursive is a search-only field.
Fields List¶
Field |
Type |
Req |
R/O |
Base |
Search |
|---|---|---|---|---|---|
directory |
String |
N |
N |
Y |
= |
is_synced_to_gm |
Bool |
N |
Y |
N |
N/A |
last_modify |
Timestamp |
N |
Y |
N |
N/A |
name |
String |
Y |
N |
Y |
: = ~ |
type |
String |
Y |
N |
Y |
= |
vtftp_dir_members |
[struct] |
N |
N |
N |
N/A |
Search-only Fields List¶
Field |
Type |
Search |
|---|---|---|
recursive |
Bool |
= |
