mv-oci-sdk 2.142.0__py3-none-any.whl → 2.142.0.1__py3-none-any.whl

oci/file_storage/models/client_options.py

@@ -0,0 +1,389 @@
+# coding: utf-8
+# Copyright (c) 2016, 2025, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20171215
+
+
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class ClientOptions(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.
+    """
+
+    #: A constant which can be used with the access property of a ClientOptions.
+    #: This constant has a value of "READ_WRITE"
+    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_ONLY"
+    ACCESS_READ_ONLY = "READ_ONLY"
+
+    #: A constant which can be used with the identity_squash property of a ClientOptions.
+    #: This constant has a value of "NONE"
+    IDENTITY_SQUASH_NONE = "NONE"
+
+    #: A constant which can be used with the identity_squash property of a ClientOptions.
+    #: This constant has a value of "ROOT"
+    IDENTITY_SQUASH_ROOT = "ROOT"
+
+    #: A constant which can be used with the identity_squash property of a ClientOptions.
+    #: This constant has a value of "ALL"
+    IDENTITY_SQUASH_ALL = "ALL"
+
+    #: A constant which can be used with the allowed_auth property of a ClientOptions.
+    #: This constant has a value of "SYS"
+    ALLOWED_AUTH_SYS = "SYS"
+
+    #: A constant which can be used with the allowed_auth property of a ClientOptions.
+    #: This constant has a value of "KRB5"
+    ALLOWED_AUTH_KRB5 = "KRB5"
+
+    #: A constant which can be used with the allowed_auth property of a ClientOptions.
+    #: This constant has a value of "KRB5I"
+    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 "KRB5P"
+    ALLOWED_AUTH_KRB5_P = "KRB5P"
+
+    def __init__(self, **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):
+
+        :param source:
+            The value to assign to the source property of this ClientOptions.
+        :type source: str
+
+        :param require_privileged_source_port:
+            The value to assign to the require_privileged_source_port property of this ClientOptions.
+        :type require_privileged_source_port: bool
+
+        :param access:
+            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'.
+        :type access: str
+
+        :param identity_squash:
+            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'.
+        :type identity_squash: str
+
+        :param anonymous_uid:
+            The value to assign to the anonymous_uid property of this ClientOptions.
+        :type anonymous_uid: int
+
+        :param anonymous_gid:
+            The value to assign to the anonymous_gid property of this ClientOptions.
+        :type anonymous_gid: int
+
+        :param is_anonymous_access_allowed:
+            The value to assign to the is_anonymous_access_allowed property of this ClientOptions.
+        :type is_anonymous_access_allowed: bool
+
+        :param allowed_auth:
+            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'.
+        :type allowed_auth: list[str]
+
+        """
+        self.swagger_types = {
+            'source': 'str',
+            'require_privileged_source_port': 'bool',
+            'access': 'str',
+            'identity_squash': 'str',
+            'anonymous_uid': 'int',
+            'anonymous_gid': 'int',
+            'is_anonymous_access_allowed': 'bool',
+            'allowed_auth': 'list[str]'
+        }
+
+        self.attribute_map = {
+            'source': 'source',
+            'require_privileged_source_port': 'requirePrivilegedSourcePort',
+            'access': 'access',
+            'identity_squash': 'identitySquash',
+            'anonymous_uid': 'anonymousUid',
+            'anonymous_gid': 'anonymousGid',
+            'is_anonymous_access_allowed': 'isAnonymousAccessAllowed',
+            'allowed_auth': 'allowedAuth'
+        }
+
+        self._source = None
+        self._require_privileged_source_port = None
+        self._access = None
+        self._identity_squash = None
+        self._anonymous_uid = None
+        self._anonymous_gid = None
+        self._is_anonymous_access_allowed = None
+        self._allowed_auth = None
+
+    @property
+    def source(self):
+        """
+        **[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.
+
+
+        :return: The source of this ClientOptions.
+        :rtype: str
+        """
+        return self._source
+
+    @source.setter
+    def source(self, source):
+        """
+        Sets 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.
+
+
+        :param source: The source of this ClientOptions.
+        :type: str
+        """
+        self._source = source
+
+    @property
+    def require_privileged_source_port(self):
+        """
+        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`.
+
+
+        :return: The require_privileged_source_port of this ClientOptions.
+        :rtype: bool
+        """
+        return self._require_privileged_source_port
+
+    @require_privileged_source_port.setter
+    def require_privileged_source_port(self, require_privileged_source_port):
+        """
+        Sets 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`.
+
+
+        :param require_privileged_source_port: The require_privileged_source_port of this ClientOptions.
+        :type: bool
+        """
+        self._require_privileged_source_port = require_privileged_source_port
+
+    @property
+    def access(self):
+        """
+        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'.
+
+
+        :return: The access of this ClientOptions.
+        :rtype: str
+        """
+        return self._access
+
+    @access.setter
+    def access(self, access):
+        """
+        Sets the access of this ClientOptions.
+        Type of access to grant clients using the file system
+        through this export. If unspecified defaults to `READ_WRITE`.
+
+
+        :param access: The access of this ClientOptions.
+        :type: str
+        """
+        allowed_values = ["READ_WRITE", "READ_ONLY"]
+        if not value_allowed_none_or_none_sentinel(access, allowed_values):
+            access = 'UNKNOWN_ENUM_VALUE'
+        self._access = access
+
+    @property
+    def identity_squash(self):
+        """
+        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'.
+
+
+        :return: The identity_squash of this ClientOptions.
+        :rtype: str
+        """
+        return self._identity_squash
+
+    @identity_squash.setter
+    def identity_squash(self, identity_squash):
+        """
+        Sets 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`.
+
+
+        :param identity_squash: The identity_squash of this ClientOptions.
+        :type: str
+        """
+        allowed_values = ["NONE", "ROOT", "ALL"]
+        if not value_allowed_none_or_none_sentinel(identity_squash, allowed_values):
+            identity_squash = 'UNKNOWN_ENUM_VALUE'
+        self._identity_squash = identity_squash
+
+    @property
+    def anonymous_uid(self):
+        """
+        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`.
+
+
+        :return: The anonymous_uid of this ClientOptions.
+        :rtype: int
+        """
+        return self._anonymous_uid
+
+    @anonymous_uid.setter
+    def anonymous_uid(self, anonymous_uid):
+        """
+        Sets 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`.
+
+
+        :param anonymous_uid: The anonymous_uid of this ClientOptions.
+        :type: int
+        """
+        self._anonymous_uid = anonymous_uid
+
+    @property
+    def anonymous_gid(self):
+        """
+        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`.
+
+
+        :return: The anonymous_gid of this ClientOptions.
+        :rtype: int
+        """
+        return self._anonymous_gid
+
+    @anonymous_gid.setter
+    def anonymous_gid(self, anonymous_gid):
+        """
+        Sets 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`.
+
+
+        :param anonymous_gid: The anonymous_gid of this ClientOptions.
+        :type: int
+        """
+        self._anonymous_gid = anonymous_gid
+
+    @property
+    def is_anonymous_access_allowed(self):
+        """
+        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.
+
+
+        :return: The is_anonymous_access_allowed of this ClientOptions.
+        :rtype: bool
+        """
+        return self._is_anonymous_access_allowed
+
+    @is_anonymous_access_allowed.setter
+    def is_anonymous_access_allowed(self, is_anonymous_access_allowed):
+        """
+        Sets 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.
+
+
+        :param is_anonymous_access_allowed: The is_anonymous_access_allowed of this ClientOptions.
+        :type: bool
+        """
+        self._is_anonymous_access_allowed = is_anonymous_access_allowed
+
+    @property
+    def allowed_auth(self):
+        """
+        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'.
+
+
+        :return: The allowed_auth of this ClientOptions.
+        :rtype: list[str]
+        """
+        return self._allowed_auth
+
+    @allowed_auth.setter
+    def allowed_auth(self, allowed_auth):
+        """
+        Sets the allowed_auth of this ClientOptions.
+        Array of allowed NFS authentication types.
+
+
+        :param allowed_auth: The allowed_auth of this ClientOptions.
+        :type: list[str]
+        """
+        allowed_values = ["SYS", "KRB5", "KRB5I", "KRB5P"]
+        if allowed_auth:
+            allowed_auth[:] = ['UNKNOWN_ENUM_VALUE' if not value_allowed_none_or_none_sentinel(x, allowed_values) else x for x in allowed_auth]
+        self._allowed_auth = allowed_auth
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other

oci/file_storage/models/create_export_details.py

@@ -0,0 +1,303 @@
+# coding: utf-8
+# Copyright (c) 2016, 2025, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20171215
+
+
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class CreateExportDetails(object):
+    """
+    Details for creating the export.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new CreateExportDetails object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param export_options:
+            The value to assign to the export_options property of this CreateExportDetails.
+        :type export_options: list[oci.file_storage.models.ClientOptions]
+
+        :param export_set_id:
+            The value to assign to the export_set_id property of this CreateExportDetails.
+        :type export_set_id: str
+
+        :param file_system_id:
+            The value to assign to the file_system_id property of this CreateExportDetails.
+        :type file_system_id: str
+
+        :param path:
+            The value to assign to the path property of this CreateExportDetails.
+        :type path: str
+
+        :param locks:
+            The value to assign to the locks property of this CreateExportDetails.
+        :type locks: list[oci.file_storage.models.ResourceLock]
+
+        :param is_idmap_groups_for_sys_auth:
+            The value to assign to the is_idmap_groups_for_sys_auth property of this CreateExportDetails.
+        :type is_idmap_groups_for_sys_auth: bool
+
+        """
+        self.swagger_types = {
+            'export_options': 'list[ClientOptions]',
+            'export_set_id': 'str',
+            'file_system_id': 'str',
+            'path': 'str',
+            'locks': 'list[ResourceLock]',
+            'is_idmap_groups_for_sys_auth': 'bool'
+        }
+
+        self.attribute_map = {
+            'export_options': 'exportOptions',
+            'export_set_id': 'exportSetId',
+            'file_system_id': 'fileSystemId',
+            'path': 'path',
+            'locks': 'locks',
+            'is_idmap_groups_for_sys_auth': 'isIdmapGroupsForSysAuth'
+        }
+
+        self._export_options = None
+        self._export_set_id = None
+        self._file_system_id = None
+        self._path = None
+        self._locks = None
+        self._is_idmap_groups_for_sys_auth = None
+
+    @property
+    def export_options(self):
+        """
+        Gets the export_options of this CreateExportDetails.
+        Export options for the new export. For exports of mount targets with
+        IPv4 address, if client options are left unspecified, client options
+        would default to:
+
+               [
+                 {
+                    \"source\" : \"0.0.0.0/0\",
+                    \"requirePrivilegedSourcePort\" : false,
+                    \"access\": \"READ_WRITE\",
+                    \"identitySquash\": \"NONE\",
+                    \"anonymousUid\": 65534,
+                    \"anonymousGid\": 65534,
+                    \"isAnonymousAccessAllowed\": false,
+                    \"allowedAuth\": [\"SYS\"]
+                  }
+               ]
+
+          For exports of mount targets with IPv6 address, if client options are
+          left unspecified, client options would be an empty array, i.e. export
+          would not be visible to any clients.
+
+          **Note:** Mount targets do not have Internet-routable IP
+          addresses.  Therefore they will not be reachable from the
+          Internet, even if an associated `ClientOptions` item has
+          a source of `0.0.0.0/0`.
+
+          **If set to the empty array then the export will not be
+          visible to any clients.**
+
+          The export's `exportOptions` can be changed after creation
+          using the `UpdateExport` operation.
+
+
+        :return: The export_options of this CreateExportDetails.
+        :rtype: list[oci.file_storage.models.ClientOptions]
+        """
+        return self._export_options
+
+    @export_options.setter
+    def export_options(self, export_options):
+        """
+        Sets the export_options of this CreateExportDetails.
+        Export options for the new export. For exports of mount targets with
+        IPv4 address, if client options are left unspecified, client options
+        would default to:
+
+               [
+                 {
+                    \"source\" : \"0.0.0.0/0\",
+                    \"requirePrivilegedSourcePort\" : false,
+                    \"access\": \"READ_WRITE\",
+                    \"identitySquash\": \"NONE\",
+                    \"anonymousUid\": 65534,
+                    \"anonymousGid\": 65534,
+                    \"isAnonymousAccessAllowed\": false,
+                    \"allowedAuth\": [\"SYS\"]
+                  }
+               ]
+
+          For exports of mount targets with IPv6 address, if client options are
+          left unspecified, client options would be an empty array, i.e. export
+          would not be visible to any clients.
+
+          **Note:** Mount targets do not have Internet-routable IP
+          addresses.  Therefore they will not be reachable from the
+          Internet, even if an associated `ClientOptions` item has
+          a source of `0.0.0.0/0`.
+
+          **If set to the empty array then the export will not be
+          visible to any clients.**
+
+          The export's `exportOptions` can be changed after creation
+          using the `UpdateExport` operation.
+
+
+        :param export_options: The export_options of this CreateExportDetails.
+        :type: list[oci.file_storage.models.ClientOptions]
+        """
+        self._export_options = export_options
+
+    @property
+    def export_set_id(self):
+        """
+        **[Required]** Gets the export_set_id of this CreateExportDetails.
+        The `OCID`__ of this export's export set.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :return: The export_set_id of this CreateExportDetails.
+        :rtype: str
+        """
+        return self._export_set_id
+
+    @export_set_id.setter
+    def export_set_id(self, export_set_id):
+        """
+        Sets the export_set_id of this CreateExportDetails.
+        The `OCID`__ of this export's export set.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :param export_set_id: The export_set_id of this CreateExportDetails.
+        :type: str
+        """
+        self._export_set_id = export_set_id
+
+    @property
+    def file_system_id(self):
+        """
+        **[Required]** Gets the file_system_id of this CreateExportDetails.
+        The `OCID`__ of this export's file system.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :return: The file_system_id of this CreateExportDetails.
+        :rtype: str
+        """
+        return self._file_system_id
+
+    @file_system_id.setter
+    def file_system_id(self, file_system_id):
+        """
+        Sets the file_system_id of this CreateExportDetails.
+        The `OCID`__ of this export's file system.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :param file_system_id: The file_system_id of this CreateExportDetails.
+        :type: str
+        """
+        self._file_system_id = file_system_id
+
+    @property
+    def path(self):
+        """
+        **[Required]** Gets the path of this CreateExportDetails.
+        Path used to access the associated file system.
+
+        Avoid entering confidential information.
+
+        Example: `/mediafiles`
+
+
+        :return: The path of this CreateExportDetails.
+        :rtype: str
+        """
+        return self._path
+
+    @path.setter
+    def path(self, path):
+        """
+        Sets the path of this CreateExportDetails.
+        Path used to access the associated file system.
+
+        Avoid entering confidential information.
+
+        Example: `/mediafiles`
+
+
+        :param path: The path of this CreateExportDetails.
+        :type: str
+        """
+        self._path = path
+
+    @property
+    def locks(self):
+        """
+        Gets the locks of this CreateExportDetails.
+        Locks associated with this resource.
+
+
+        :return: The locks of this CreateExportDetails.
+        :rtype: list[oci.file_storage.models.ResourceLock]
+        """
+        return self._locks
+
+    @locks.setter
+    def locks(self, locks):
+        """
+        Sets the locks of this CreateExportDetails.
+        Locks associated with this resource.
+
+
+        :param locks: The locks of this CreateExportDetails.
+        :type: list[oci.file_storage.models.ResourceLock]
+        """
+        self._locks = locks
+
+    @property
+    def is_idmap_groups_for_sys_auth(self):
+        """
+        Gets the is_idmap_groups_for_sys_auth of this CreateExportDetails.
+        Whether or not the export should use ID mapping for Unix groups rather than the group list provided within an NFS request's RPC header. When this flag is true the Unix UID from the RPC header is used to retrieve the list of secondary groups from a the ID mapping subsystem. The primary GID is always taken from the RPC header. If ID mapping is not configured, incorrectly configured, unavailable, or cannot be used to determine a list of secondary groups then an empty secondary group list is used for authorization. If the number of groups exceeds the limit of 256 groups, the list retrieved from LDAP is truncated to the first 256 groups read.
+
+
+        :return: The is_idmap_groups_for_sys_auth of this CreateExportDetails.
+        :rtype: bool
+        """
+        return self._is_idmap_groups_for_sys_auth
+
+    @is_idmap_groups_for_sys_auth.setter
+    def is_idmap_groups_for_sys_auth(self, is_idmap_groups_for_sys_auth):
+        """
+        Sets the is_idmap_groups_for_sys_auth of this CreateExportDetails.
+        Whether or not the export should use ID mapping for Unix groups rather than the group list provided within an NFS request's RPC header. When this flag is true the Unix UID from the RPC header is used to retrieve the list of secondary groups from a the ID mapping subsystem. The primary GID is always taken from the RPC header. If ID mapping is not configured, incorrectly configured, unavailable, or cannot be used to determine a list of secondary groups then an empty secondary group list is used for authorization. If the number of groups exceeds the limit of 256 groups, the list retrieved from LDAP is truncated to the first 256 groups read.
+
+
+        :param is_idmap_groups_for_sys_auth: The is_idmap_groups_for_sys_auth of this CreateExportDetails.
+        :type: bool
+        """
+        self._is_idmap_groups_for_sys_auth = is_idmap_groups_for_sys_auth
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other