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.

Attributes

`ACCESS_READ_ONLY`	A constant which can be used with the access property of a ClientOptions.
`ACCESS_READ_WRITE`	A constant which can be used with the access property of a ClientOptions.
`ALLOWED_AUTH_KRB5`	A constant which can be used with the allowed_auth property of a ClientOptions.
`ALLOWED_AUTH_KRB5_I`	A constant which can be used with the allowed_auth property of a ClientOptions.
`ALLOWED_AUTH_KRB5_P`	A constant which can be used with the allowed_auth property of a ClientOptions.
`ALLOWED_AUTH_SYS`	A constant which can be used with the allowed_auth property of a ClientOptions.
`IDENTITY_SQUASH_ALL`	A constant which can be used with the identity_squash property of a ClientOptions.
`IDENTITY_SQUASH_NONE`	A constant which can be used with the identity_squash property of a ClientOptions.
`IDENTITY_SQUASH_ROOT`	A constant which can be used with the identity_squash property of a ClientOptions.
`access`	Gets the access of this ClientOptions.
`allowed_auth`	Gets the allowed_auth of this ClientOptions.
`anonymous_gid`	Gets the anonymous_gid of this ClientOptions.
`anonymous_uid`	Gets the anonymous_uid of this ClientOptions.
`identity_squash`	Gets the identity_squash of this ClientOptions.
`is_anonymous_access_allowed`	Gets the is_anonymous_access_allowed of this ClientOptions.
`require_privileged_source_port`	Gets the require_privileged_source_port of this ClientOptions.
`source`	[Required] Gets the source of this ClientOptions.

Methods

__init__(**kwargs) Initializes a new ClientOptions object with values from keyword arguments.

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”

ALLOWED_AUTH_KRB5 = 'KRB5'¶: A constant which can be used with the allowed_auth property of a ClientOptions. This constant has a value of “KRB5”

ALLOWED_AUTH_KRB5_I = 'KRB5I'¶: A constant which can be used with the allowed_auth property of a ClientOptions. This constant has a value of “KRB5I”

ALLOWED_AUTH_KRB5_P = 'KRB5P'¶: A constant which can be used with the allowed_auth property of a ClientOptions. This constant has a value of “KRB5P”

ALLOWED_AUTH_SYS = 'SYS'¶: A constant which can be used with the allowed_auth property of a ClientOptions. This constant has a value of “SYS”

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.
is_anonymous_access_allowed (bool) – The value to assign to the is_anonymous_access_allowed property of this ClientOptions.
allowed_auth (list[str]) – The value to assign to the allowed_auth property of this ClientOptions. Allowed values for items in this list are: “SYS”, “KRB5”, “KRB5I”, “KRB5P”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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_WRITE.

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

allowed_auth¶

Gets the allowed_auth of this ClientOptions. Array of allowed NFS authentication types.

Allowed values for items in this list are: “SYS”, “KRB5”, “KRB5I”, “KRB5P”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The allowed_auth of this ClientOptions.
Return type:	list[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

is_anonymous_access_allowed¶

Gets the is_anonymous_access_allowed of this ClientOptions. Whether or not to enable anonymous access to the file system through this export in cases where a user isn’t found in the LDAP server used for ID mapping. If true, and the user is not found in the LDAP directory, the operation uses the Squash UID and Squash GID.

Returns:	The is_anonymous_access_allowed of this ClientOptions.
Return type:	bool

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