ftpuser : FTP user object.

The FTP user represents the user accounts to be used with the FTP client.

Object Reference

References to ftpuser are object references.

The name part of the FTP user object reference has the following components:

• The FTP username

Example:

ftpuser/ ZG5zLm9wdGlvbl9kZWZpbml0aW9uJGluZm8uLmZhbHNlLjI1Mg:user1

Restrictions

The object does not support the following operations:

• Scheduling

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

The following fields are required to create this object:

Field	Notes
create_home_dir	See the field description for more information
home_dir	See the field description for more information
password
username

create_home_dir

create_home_dir

Determines whether to create the home directory with the user name or to use the existing directory as the home directory.

Type

Bool.

Create

You cannot specify home_dir when create_home_dir is set to True

Search

The field is not available for search.

Notes

The create_home_dir cannot be updated.

create_home_dir is not readable.

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.

home_dir

home_dir

The absolute path of the FTP user’s home directory.

Type

String.

Create

You must specify home_dir when create_home_dir is set to False

Search

The field is not available for search.

Notes

The home_dir cannot be updated.

password

password

The FTP user password.

Type

String.

Create

The field is required on creation.

Search

The field is not available for search.

Notes

password is not readable.

permission

permission

The FTP user permission.

Type

String.

Valid values are:

• RO
• RW

Create

The default value is RO.

Search

The field is not available for search.

username

username

The FTP user name.

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

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

Notes

The username is part of the base object.

The username cannot be updated.

Fields List

Field	Type	Req	R/O	Base	Search
create_home_dir	Bool	Y*	N	N	N/A
extattrs	Extattr	N	N	N	ext
home_dir	String	Y*	N	N	N/A
password	String	Y	N	N	N/A
permission	String	N	N	N	N/A
username	String	Y	N	Y	: = ~

* Required in some cases, see detailed field description above.