member:filedistribution : Grid member file distribution object.

The Grid member file distribution object is used to configure file distribution services such as TFTP, FTP and HTTP, and access control lists (ACL) that determine which clients are granted access to the service (TFTP, FTP, HTTP), and which clients are denied access to the service.

Object Reference

References to member:filedistribution are object references.

The name part of the Grid member file distribution object reference has the following components:

  • The Grid member name
Example:
member:filedistribution/ ZG5zLm9wdGlvbl9kZWZpbml0aW9uJGluZm8uLmZhbHNlLjI1Mg:hostname.com

Restrictions

The object does not support the following operations:

  • Create (insert)
  • Delete
  • 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): host_name, ipv4_address, ipv6_address, status.

allow_uploads

allow_uploads

Determines whether uploads to the Grid member are allowed.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

Notes

allow_uploads is associated with the field use_allow_uploads (see use flag).

comment

comment

The Grid member descriptive comment.

Type

String.

Search

The field is available for search via

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

Notes

The comment cannot be updated.

comment cannot be written.

enable_ftp

enable_ftp

Determines whether the FTP prtocol is enabled for file distribution.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

enable_ftp_filelist

enable_ftp_filelist

Determines whether the LIST command for FTP is enabled.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

enable_ftp_passive

enable_ftp_passive

Determines whether the passive mode for FTP is enabled.

Type

Bool.

Create

The default value is True.

Search

The field is not available for search.

enable_http

enable_http

Determines whether the HTTP prtocol is enabled for file distribution.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

enable_http_acl

enable_http_acl

Determines whether the HTTP prtocol access control (AC) settings are enabled.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

enable_tftp

enable_tftp

Determines whether the TFTP prtocol is enabled for file distribution.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

ftp_acls

ftp_acls

Access control (AC) settings for the FTP protocol.

Type

A/An Address ac struct array.

Create

The default value is:

empty

Search

The field is not available for search.

ftp_port

ftp_port

The network port used by the FTP protocol.

Type

Unsigned integer.

Create

The default value is 21.

Search

The field is not available for search.

ftp_status

ftp_status

The FTP protocol status.

Type

String.

Valid values are:
  • FAILED
  • INACTIVE
  • UNKNOWN
  • WARNING
  • WORKING

Search

The field is not available for search.

Notes

The ftp_status cannot be updated.

ftp_status cannot be written.

host_name

host_name

The Grid member host name.

Type

String.

Search

The field is available for search via

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

Notes

The host_name is part of the base object.

The host_name cannot be updated.

host_name cannot be written.

http_acls

http_acls

Access control (AC) settings for the HTTP protocol.

Type

A/An Address ac struct array.

Create

The default value is:

empty

Search

The field is not available for search.

http_status

http_status

The HTTP protocol status.

Type

String.

Valid values are:
  • FAILED
  • INACTIVE
  • UNKNOWN
  • WARNING
  • WORKING

Search

The field is not available for search.

Notes

The http_status cannot be updated.

http_status cannot be written.

ipv4_address

ipv4_address

The IPv4 address of the Grid member.

Type

String.

Search

The field is available for search via

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

Notes

The ipv4_address is part of the base object.

The ipv4_address cannot be updated.

ipv4_address cannot be written.

ipv6_address

ipv6_address

The IPv6 address of the Grid member.

Type

String.

Search

The field is available for search via

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

Notes

The ipv6_address is part of the base object.

The ipv6_address cannot be updated.

ipv6_address cannot be written.

status

status

The Grid member file distribution status.

Type

String.

Valid values are:
  • FAILED
  • INACTIVE
  • UNKNOWN
  • WARNING
  • WORKING

Search

The field is not available for search.

Notes

The status is part of the base object.

The status cannot be updated.

status cannot be written.

tftp_acls

tftp_acls

The access control (AC) settings for the TFTP protocol.

Type

A/An Address ac struct array.

Create

The default value is:

empty

Search

The field is not available for search.

tftp_port

tftp_port

The network port used by the TFTP protocol.

Type

Unsigned integer.

Create

The default value is 69.

Search

The field is not available for search.

tftp_status

tftp_status

The TFTP protocol status.

Type

String.

Valid values are:
  • FAILED
  • INACTIVE
  • UNKNOWN
  • WARNING
  • WORKING

Search

The field is not available for search.

Notes

The tftp_status cannot be updated.

tftp_status cannot be written.

use_allow_uploads

use_allow_uploads

Use flag for: allow_uploads

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

Fields List

Field Type Req R/O Base Search
allow_uploads Bool N N N N/A
comment String N Y N : = ~
enable_ftp Bool N N N N/A
enable_ftp_filelist Bool N N N N/A
enable_ftp_passive Bool N N N N/A
enable_http Bool N N N N/A
enable_http_acl Bool N N N N/A
enable_tftp Bool N N N N/A
ftp_acls [struct] N N N N/A
ftp_port Unsigned int N N N N/A
ftp_status String N Y N N/A
host_name String N Y Y : = ~
http_acls [struct] N N N N/A
http_status String N Y N N/A
ipv4_address String N Y Y = ~
ipv6_address String N Y Y = ~
status String N Y Y N/A
tftp_acls [struct] N N N N/A
tftp_port Unsigned int N N N N/A
tftp_status String N Y N N/A
use_allow_uploads Bool N N N N/A