ClientOptions

class oci.file_storage.models.ClientOptions(**kwargs)

Bases: object

NFS export options applied to a specified set of clients. Only governs access through the associated export. Access to the same file system through a different export (on the same or different mount target) will be governed by that export's export options.

ACCESS_READ_ONLY = 'READ_ONLY'

A constant which can be used with the access property of a ClientOptions. This constant has a value of "READ_ONLY"

ACCESS_READ_WRITE = 'READ_WRITE'

A constant which can be used with the access property of a ClientOptions. This constant has a value of "READ_WRITE"

IDENTITY_SQUASH_ALL = 'ALL'

A constant which can be used with the identity_squash property of a ClientOptions. This constant has a value of "ALL"

IDENTITY_SQUASH_NONE = 'NONE'

A constant which can be used with the identity_squash property of a ClientOptions. This constant has a value of "NONE"

IDENTITY_SQUASH_ROOT = 'ROOT'

A constant which can be used with the identity_squash property of a ClientOptions. This constant has a value of "ROOT"

__init__(**kwargs)

Initializes a new ClientOptions object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • source (str) -- The value to assign to the source property of this ClientOptions.
  • require_privileged_source_port (bool) -- The value to assign to the require_privileged_source_port property of this ClientOptions.
  • access (str) -- The value to assign to the access property of this ClientOptions. Allowed values for this property are: "READ_WRITE", "READ_ONLY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
  • identity_squash (str) -- The value to assign to the identity_squash property of this ClientOptions. Allowed values for this property are: "NONE", "ROOT", "ALL", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
  • anonymous_uid (int) -- The value to assign to the anonymous_uid property of this ClientOptions.
  • anonymous_gid (int) -- The value to assign to the anonymous_gid property of this ClientOptions.
access

Gets the access of this ClientOptions. Type of access to grant clients using the file system through this export. If unspecified defaults to READ_ONLY.

Allowed values for this property are: "READ_WRITE", "READ_ONLY", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.

Returns:The access of this ClientOptions.
Return type:str
anonymous_gid

Gets the anonymous_gid of this ClientOptions. GID value to remap to when squashing a client GID (see identitySquash for more details.) If unspecified defaults to 65534.

Returns:The anonymous_gid of this ClientOptions.
Return type:int
anonymous_uid

Gets the anonymous_uid of this ClientOptions. UID value to remap to when squashing a client UID (see identitySquash for more details.) If unspecified, defaults to 65534.

Returns:The anonymous_uid of this ClientOptions.
Return type:int
identity_squash

Gets the identity_squash of this ClientOptions. Used when clients accessing the file system through this export have their UID and GID remapped to 'anonymousUid' and 'anonymousGid'. If ALL, all users and groups are remapped; if ROOT, only the root user and group (UID/GID 0) are remapped; if NONE, no remapping is done. If unspecified, defaults to ROOT.

Allowed values for this property are: "NONE", "ROOT", "ALL", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.

Returns:The identity_squash of this ClientOptions.
Return type:str
require_privileged_source_port

Gets the require_privileged_source_port of this ClientOptions. If true, clients accessing the file system through this export must connect from a privileged source port. If unspecified, defaults to true.

Returns:The require_privileged_source_port of this ClientOptions.
Return type:bool
source

[Required] Gets the source of this ClientOptions. Clients these options should apply to. Must be a either single IPv4 address or single IPv4 CIDR block.

Note: Access will also be limited by any applicable VCN security rules and the ability to route IP packets to the mount target. Mount targets do not have Internet-routable IP addresses.

Returns:The source of this ClientOptions.
Return type:str